vitessio
/
vitess
mirror of https://github.com/vitessio/vitess.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge flags-refactor branch to main (#18280) 

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Co-authored-by: Rohit Nayak <rohit@planetscale.com>
This commit is contained in:
Mounica Sruthi 2025-05-22 15:21:11 +05:30 committed by GitHub
parent 55564ca78a
commit 86652300fe
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
198 changed files with 2317 additions and 1756 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -93,3 +93,4 @@ report
# mise files
.mise.toml
/errors/
go/flags/endtoend/count_flags.sh

40
config/tablet/default.yaml
View File

@ -1,34 +1,34 @@
tabletID: zone-1234
init:
dbName: # init_db_name_override
keyspace: # init_keyspace
shard: # init_shard
tabletType: # init_tablet_type
dbName: # init-db-name-override
keyspace: # init-keyspace
shard: # init-shard
tabletType: # init-tablet-type
timeoutSeconds: 60 # init_timeout
db:
socket: # db_socket
host: # db_host
port: 0 # db_port
charSet: # db_charset
flags: 0 # db_flags
flavor: # db_flavor
sslCa: # db_ssl_ca
sslCaPath: # db_ssl_ca_path
sslCert: # db_ssl_cert
sslKey: # db_ssl_key
serverName: # db_server_name
connectTimeoutMilliseconds: 0 # db_connect_timeout_ms
socket: # db-socket
host: # db-host
port: 0 # db-port
charSet: # db-charset
flags: 0 # db-flags
flavor: # db-flavor
sslCa: # db-ssl-ca
sslCaPath: # db-ssl-ca-path
sslCert: # db-ssl-cert
sslKey: # db-ssl-key
serverName: # db-server-name
connectTimeoutMilliseconds: 0 # db-connect-timeout-ms
app:
user: vt_app # db_app_user
password: # db_app_password
useSsl: true # db_app_use_ssl
preferTcp: false
dba:
user: vt_dba # db_dba_user
password: # db_dba_password
useSsl: true # db_dba_use_ssl
user: vt_dba # db-dba-user
password: # db-dba-password
useSsl: true # db-dba-use-ssl
preferTcp: false
filtered:
user: vt_filtered # db_filtered_user
@ -87,7 +87,7 @@ gracePeriods:
replicationTracker:
mode: disable # enable_replication_reporter
heartbeatIntervalMilliseconds: 0 # heartbeat_enable, heartbeat_interval
heartbeatIntervalMilliseconds: 0 # heartbeat-enable, heartbeat-interval
hotRowProtection:
mode: disable|dryRun|enable # enable_hot_row_protection, enable_hot_row_protection_dry_run

4
doc/design-docs/TopoLocks.md
View File

@ -15,7 +15,7 @@ The implementations of `LockShard` and `CheckShardLocked` differ slightly for al
### Etcd
In Etcd implementation, we use `KeepAlive` API to keep renewing the context that we have for acquiring the shard lock every 10 seconds. The duration of the lease is controlled by the `--topo_etcd_lease_ttl` flag which defaults to 10 seconds. Once we acquire the shard lock, the context for acquiring the shard lock expires and that stops the KeepAlives too.
In Etcd implementation, we use `KeepAlive` API to keep renewing the context that we have for acquiring the shard lock every 10 seconds. The duration of the lease is controlled by the `--topo-etcd-lease-ttl` flag which defaults to 10 seconds. Once we acquire the shard lock, the context for acquiring the shard lock expires and that stops the KeepAlives too.
The shard lock is released either when the unlock function is called, or if the lease ttl expires. This guards against servers crashing while holding the shard lock.
@ -30,6 +30,6 @@ The Check function doesn't do anything in ZooKeeper. The implementation just ret
### Consul
In Consul, the timeout for the lock is controlled by the `--topo_consul_lock_session_ttl` flag.
In Consul, the timeout for the lock is controlled by the `--topo-consul-lock-session-ttl` flag.
The Check function works properly and checks if the lock still exists.

1
docker/mini/vtctld-mini-up.sh
View File

@ -23,6 +23,7 @@ grpc_port=15999
echo "- Starting vtctld..."
# shellcheck disable=SC2086
#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
vtctld \
$TOPOLOGY_FLAGS \
--disable_active_reparents \

1
docker/mini/vttablet-mini-up.sh
View File

@ -39,6 +39,7 @@ echo "> Starting vttablet for server $mysql_host:$mysql_port"
echo " - Tablet alias is $alias"
echo " - Tablet listens on http://$hostname:$port"
# shellcheck disable=SC2086
#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
vttablet \
$TOPOLOGY_FLAGS \
-log_dir $VTDATAROOT/tmp \

2
docker/vttestserver/run.sh
View File

@ -36,7 +36,7 @@ rm -vf "$VTDATAROOT"/"$tablet_dir"/{mysql.sock,mysql.sock.lock}
--num_shards "$NUM_SHARDS" \
--mysql_bind_host "${MYSQL_BIND_HOST:-127.0.0.1}" \
--vtcombo-bind-host "${VTCOMBO_BIND_HOST:-127.0.0.1}" \
--mysql_server_version "${MYSQL_SERVER_VERSION:-$1}" \
--mysql-server-version "${MYSQL_SERVER_VERSION:-$1}" \
--charset "${CHARSET:-utf8mb4}" \
--foreign_key_mode "${FOREIGN_KEY_MODE:-allow}" \
--enable_online_ddl="${ENABLE_ONLINE_DDL:-true}" \

3
examples/common/env.sh
View File

@ -53,6 +53,7 @@ if [ "${TOPO}" = "zk2" ]; then
# Set topology environment parameters.
ZK_SERVER="localhost:21811,localhost:21812,localhost:21813"
# shellcheck disable=SC2034
#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
TOPOLOGY_FLAGS="--topo_implementation zk2 --topo_global_server_address ${ZK_SERVER} --topo_global_root /vitess/global"
mkdir -p "${VTDATAROOT}/tmp"
@ -61,10 +62,12 @@ elif [ "${TOPO}" = "consul" ]; then
CONSUL_SERVER=127.0.0.1
CONSUL_HTTP_PORT=8500
CONSUL_SERVER_PORT=8300
#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
TOPOLOGY_FLAGS="--topo_implementation consul --topo_global_server_address ${CONSUL_SERVER}:${CONSUL_HTTP_PORT} --topo_global_root vitess/global/"
mkdir -p "${VTDATAROOT}/consul"
else
ETCD_SERVER="localhost:2379"
#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
TOPOLOGY_FLAGS="--topo_implementation etcd2 --topo_global_server_address $ETCD_SERVER --topo_global_root /vitess/global"
mkdir -p "${VTDATAROOT}/etcd"

1
examples/common/scripts/mysqlctl-down.sh
View File

@ -24,5 +24,6 @@ uid=$TABLET_UID
printf -v alias '%s-%010d' $cell $uid
echo "Shutting down MySQL for tablet $alias..."
#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
mysqlctl --tablet_uid $uid shutdown

1
examples/common/scripts/mysqlctl-up.sh
View File

@ -35,6 +35,7 @@ if [ -d $VTDATAROOT/$tablet_dir ]; then
action='start'
fi
#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
mysqlctl \
--log_dir $VTDATAROOT/tmp \
--tablet_uid $uid \

1
examples/common/scripts/vtctld-up.sh
View File

@ -23,6 +23,7 @@ grpc_port=15999
echo "Starting vtctld..."
# shellcheck disable=SC2086
#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
vtctld \
$TOPOLOGY_FLAGS \
--cell $cell \

3
examples/common/scripts/vtgate-up.sh
View File

@ -26,6 +26,7 @@ mysql_server_socket_path="/tmp/mysql.sock"
echo "Starting vtgate..."
# shellcheck disable=SC2086
#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
vtgate \
$TOPOLOGY_FLAGS \
--log_dir $VTDATAROOT/tmp \
@ -36,7 +37,7 @@ vtgate \
--mysql_server_socket_path $mysql_server_socket_path \
--cell $cell \
--cells_to_watch $cell \
--tablet_types_to_wait PRIMARY,REPLICA \
--tablet-types-to-wait PRIMARY,REPLICA \
--service_map 'grpc-vtgateservice' \
--pid_file $VTDATAROOT/tmp/vtgate.pid \
--enable_buffer \

2
examples/compose/.env
View File

@ -1,4 +1,4 @@
TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500 --topo_global_root vitess/global
TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500 --topo-global-root vitess/global
GRPC_PORT=15999
WEB_PORT=8080
MYSQL_PORT=15306

18
examples/compose/docker-compose.beginners.yml
View File

@ -63,14 +63,15 @@ services:
- "15000:$WEB_PORT"
- "$GRPC_PORT"
command: ["sh", "-c", " /vt/bin/vtctld \
# TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
$TOPOLOGY_FLAGS \
--cell $CELL \
--service_map 'grpc-vtctl,grpc-vtctld' \
--backup_storage_implementation file \
--service-map 'grpc-vtctl,grpc-vtctld' \
--backup-storage-implementation file \
--file_backup_storage_root /vt/vtdataroot/backups \
--logtostderr=true \
--port $WEB_PORT \
--grpc_port $GRPC_PORT
--grpc-port $GRPC_PORT
"]
depends_on:
consul1:
@ -89,16 +90,17 @@ services:
- "$GRPC_PORT"
- "15306:$MYSQL_PORT"
command: ["sh", "-c", "/vt/bin/vtgate \
# TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
$TOPOLOGY_FLAGS \
--logtostderr=true \
--port $WEB_PORT \
--grpc_port $GRPC_PORT \
--mysql_server_port $MYSQL_PORT \
--mysql_auth_server_impl none \
--grpc-port $GRPC_PORT \
--mysql-server-port $MYSQL_PORT \
--mysql-auth-server-impl none \
--cell $CELL \
--cells_to_watch $CELL \
--tablet_types_to_wait PRIMARY,REPLICA \
--service_map 'grpc-vtgateservice' \
--tablet-types-to-wait PRIMARY,REPLICA \
--service-map 'grpc-vtgateservice' \
--enable_system_settings=true \
"]
volumes:

56
examples/compose/docker-compose.yml
View File

@ -63,8 +63,8 @@ services:
vttablet301:
condition: service_healthy
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -89,8 +89,8 @@ services:
vttablet201:
condition: service_healthy
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -126,8 +126,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- EXTERNAL_DB=0
image: vitess/lite:${VITESS_TAG:-latest}
volumes:
@ -136,10 +136,10 @@ services:
command:
- sh
- -c
- ' /vt/bin/vtctld --topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global --cell test
--service_map ''grpc-vtctl,grpc-vtctld'' --backup_storage_implementation file --file_backup_storage_root
/vt/vtdataroot/backups --logtostderr=true --port 8080 --grpc_port 15999 '
- ' /vt/bin/vtctld --topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global --cell test
--service-map ''grpc-vtctl,grpc-vtctld'' --backup-storage-implementation file --file_backup_storage_root
/vt/vtdataroot/backups --logtostderr=true --port 8080 --grpc-port 15999 '
depends_on:
external_db_host:
condition: service_healthy
@ -153,10 +153,10 @@ services:
command:
- sh
- -c
- '/script/run-forever.sh /vt/bin/vtgate --topo_implementation consul --topo_global_server_address
consul1:8500 --topo_global_root vitess/global --logtostderr=true --port 8080 --grpc_port
15999 --mysql_server_port 15306 --mysql_auth_server_impl none --cell test --cells_to_watch
test --tablet_types_to_wait PRIMARY,REPLICA,RDONLY --service_map ''grpc-vtgateservice''
- '/script/run-forever.sh /vt/bin/vtgate --topo-implementation consul --topo-global-server-address
consul1:8500 --topo-global-root vitess/global --logtostderr=true --port 8080 --grpc-port
15999 --mysql-server-port 15306 --mysql-auth-server-impl none --cell test --cells_to_watch
test --tablet-types-to-wait PRIMARY,REPLICA,RDONLY --service-map ''grpc-vtgateservice''
--normalize_queries=true '
depends_on:
- vtctld
@ -176,8 +176,8 @@ services:
- vtctld
- set_keyspace_durability_policy
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- EXTERNAL_DB=0
- DB_USER=
@ -195,8 +195,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -232,8 +232,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -269,8 +269,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -306,8 +306,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -343,8 +343,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -380,8 +380,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test

2
examples/compose/template.env
View File

@ -1,4 +1,4 @@
TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500 --topo_global_root vitess/global
TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500 --topo-global-root vitess/global
GRPC_PORT=15999
WEB_PORT=8080
MYSQL_PORT=15306

56
examples/compose/vtcompose/docker-compose.test.yml
View File

@ -67,8 +67,8 @@ services:
vttablet201:
condition: service_healthy
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -91,8 +91,8 @@ services:
vttablet301:
condition: service_healthy
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -141,8 +141,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- EXTERNAL_DB=0
image: vitess/lite:${VITESS_TAG:-latest}
volumes:
@ -151,11 +151,11 @@ services:
command:
- sh
- -c
- ' /vt/bin/vtctld --topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global --cell test
--service_map ''grpc-vtctl,grpc-vtctld'' --backup_storage_implementation file
--file_backup_storage_root /vt/vtdataroot/backups --logtostderr=true --port
8080 --grpc_port 15999 '
- ' /vt/bin/vtctld --topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global --cell test
--service-map ''grpc-vtctl,grpc-vtctld'' --backup-storage-implementation file
--file_backup_storage_root /vt/vtdataroot/backups --logtostderr=true --port
8080 --grpc-port 15999 '
depends_on:
external_db_host:
condition: service_healthy
@ -169,11 +169,11 @@ services:
command:
- sh
- -c
- '/script/run-forever.sh /vt/bin/vtgate --topo_implementation consul --topo_global_server_address
consul1:8500 --topo_global_root vitess/global --logtostderr=true --port 8080
--grpc_port 15999 --mysql_server_port 15306 --mysql_auth_server_impl none --cell
test --cells_to_watch test --tablet_types_to_wait PRIMARY,REPLICA,RDONLY --service_map
''grpc-vtgateservice'' --normalize_queries=true '
- '/script/run-forever.sh /vt/bin/vtgate --topo-implementation consul --topo-global-server-address
consul1:8500 --topo-global-root vitess/global --logtostderr=true --port 8080
--grpc-port 15999 --mysql-server-port 15306 --mysql-auth-server-impl none --cell
test --cells_to_watch test --tablet-types-to-wait PRIMARY,REPLICA,RDONLY --service-map
''grpc-vtgateservice'' --normalize_queries=true '
depends_on:
- vtctld
image: vitess/lite:${VITESS_TAG:-latest}
@ -194,8 +194,8 @@ services:
- vtctld
environment:
- WEB_PORT=8080
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- EXTERNAL_DB=0
- DB_USER=
- DB_PASS=
@ -212,8 +212,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -249,8 +249,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -286,8 +286,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -323,8 +323,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test
@ -360,8 +360,8 @@ services:
depends_on:
- vtctld
environment:
- TOPOLOGY_FLAGS=--topo_implementation consul --topo_global_server_address consul1:8500
--topo_global_root vitess/global
- TOPOLOGY_FLAGS=--topo-implementation consul --topo-global-server-address consul1:8500
--topo-global-root vitess/global
- WEB_PORT=8080
- GRPC_PORT=15999
- CELL=test

18
examples/compose/vtcompose/vtcompose.go
View File

@ -46,7 +46,7 @@ const (
cellUsage = "Vitess Cell name"
DefaultExternalDbData = ""
externalDbDataUsage = "List of Data corresponding to external DBs. List of <external_db_name>,<DB_HOST>,<DB_PORT>,<DB_USER>,<DB_PASS>,<DB_CHARSET> separated by ';'"
DefaultTopologyFlags = "--topo_implementation consul --topo_global_server_address consul1:8500 --topo_global_root vitess/global"
DefaultTopologyFlags = "--topo-implementation consul --topo-global-server-address consul1:8500 --topo-global-root vitess/global"
topologyFlagsUsage = "Vitess Topology Flags config"
)
@ -632,12 +632,12 @@ func generateVtctld(opts vtOptions) string {
command: ["sh", "-c", " /vt/bin/vtctld \
%[3]s \
--cell %[4]s \
--service_map 'grpc-vtctl,grpc-vtctld' \
--backup_storage_implementation file \
--service-map 'grpc-vtctl,grpc-vtctld' \
--backup-storage-implementation file \
--file_backup_storage_root /vt/vtdataroot/backups \
--logtostderr=true \
--port %[1]d \
--grpc_port %[2]d \
--grpc-port %[2]d \
"]
volumes:
- .:/script
@ -665,13 +665,13 @@ func generateVtgate(opts vtOptions) string {
%[4]s \
--logtostderr=true \
--port %[1]d \
--grpc_port %[2]d \
--mysql_server_port %[3]d \
--mysql_auth_server_impl none \
--grpc-port %[2]d \
--mysql-server-port %[3]d \
--mysql-auth-server-impl none \
--cell %[5]s \
--cells_to_watch %[5]s \
--tablet_types_to_wait PRIMARY,REPLICA,RDONLY \
--service_map 'grpc-vtgateservice' \
--tablet-types-to-wait PRIMARY,REPLICA,RDONLY \
--service-map 'grpc-vtgateservice' \
--normalize_queries=true \
"]
volumes:

3
examples/compose/vttablet-up.sh
View File

@ -95,6 +95,7 @@ rm -rf $VTDATAROOT/$tablet_dir/{mysql.sock,mysql.sock.lock}
# Create mysql instances
# Do not create mysql instance for primary if connecting to external mysql database
#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
if [[ $tablet_role != "externalprimary" ]]; then
echo "Initing mysql for tablet: $uid role: $role external: $external.. "
$VTROOT/bin/mysqlctld \
@ -142,7 +143,7 @@ else
--restore_from_backup"
fi
#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
echo "Starting vttablet..."
exec $VTROOT/bin/vttablet \
$TOPOLOGY_FLAGS \

4
examples/operator/101_initial_cluster.yaml
View File

@ -44,7 +44,7 @@ spec:
cells:
- zone1
extraFlags:
security_policy: read-only
security-policy: read-only
replicas: 1
resources:
limits:
@ -101,7 +101,7 @@ spec:
replicas: 2
vttablet:
extraFlags:
db_charset: utf8mb4
db-charset: utf8mb4
resources:
limits:
memory: 256Mi

6
examples/operator/201_customer_tablets.yaml
View File

@ -40,7 +40,7 @@ spec:
cells:
- zone1
extraFlags:
security_policy: read-only
security-policy: read-only
replicas: 1
resources:
limits:
@ -97,7 +97,7 @@ spec:
replicas: 2
vttablet:
extraFlags:
db_charset: utf8mb4
db-charset: utf8mb4
resources:
limits:
memory: 256Mi
@ -132,7 +132,7 @@ spec:
replicas: 2
vttablet:
extraFlags:
db_charset: utf8mb4
db-charset: utf8mb4
resources:
limits:
memory: 256Mi

8
examples/operator/302_new_shards.yaml
View File

@ -40,7 +40,7 @@ spec:
cells:
- zone1
extraFlags:
security_policy: read-only
security-policy: read-only
replicas: 1
resources:
limits:
@ -97,7 +97,7 @@ spec:
replicas: 2
vttablet:
extraFlags:
db_charset: utf8mb4
db-charset: utf8mb4
resources:
limits:
memory: 256Mi
@ -132,7 +132,7 @@ spec:
replicas: 2
vttablet:
extraFlags:
db_charset: utf8mb4
db-charset: utf8mb4
resources:
limits:
memory: 256Mi
@ -163,7 +163,7 @@ spec:
replicas: 2
vttablet:
extraFlags:
db_charset: utf8mb4
db-charset: utf8mb4
resources:
limits:
memory: 256Mi

6
examples/operator/306_down_shard_0.yaml
View File

@ -40,7 +40,7 @@ spec:
cells:
- zone1
extraFlags:
security_policy: read-only
security-policy: read-only
replicas: 1
resources:
limits:
@ -97,7 +97,7 @@ spec:
replicas: 2
vttablet:
extraFlags:
db_charset: utf8mb4
db-charset: utf8mb4
resources:
limits:
memory: 256Mi
@ -132,7 +132,7 @@ spec:
replicas: 2
vttablet:
extraFlags:
db_charset: utf8mb4
db-charset: utf8mb4
resources:
limits:
memory: 256Mi

6
examples/operator/401_scheduled_backups.yaml
View File

@ -74,7 +74,7 @@ spec:
cells:
- zone1
extraFlags:
security_policy: read-only
security-policy: read-only
replicas: 1
resources:
limits:
@ -131,7 +131,7 @@ spec:
replicas: 2
vttablet:
extraFlags:
db_charset: utf8mb4
db-charset: utf8mb4
wait_for_backup_interval: "0"
resources:
limits:
@ -167,7 +167,7 @@ spec:
replicas: 2
vttablet:
extraFlags:
db_charset: utf8mb4
db-charset: utf8mb4
wait_for_backup_interval: "0"
resources:
limits:

7
go/acl/acl.go
View File

@ -23,7 +23,7 @@ limitations under the License.
// own policy as a package that calls RegisterPolicy(), and compile it into all
// Vitess binaries that you use.
//
// By default (when no security_policy is specified), everyone is allowed to do
// By default (when no security-policy is specified), everyone is allowed to do
// anything.
//
// For convenience, there are two other built-in policies that also do NOT do
@ -43,6 +43,7 @@ import (
"github.com/spf13/pflag"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)
// This is a list of predefined roles. Applications are free
@ -70,7 +71,7 @@ type Policy interface {
}
func RegisterFlags(fs *pflag.FlagSet) {
fs.StringVar(&securityPolicy, "security_policy", securityPolicy, "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)")
utils.SetFlagStringVar(fs, &securityPolicy, "security-policy", securityPolicy, "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)")
}
// RegisterPolicy registers a security policy. This function must be called
@ -94,7 +95,7 @@ func savePolicy() {
currentPolicy = policy
return
}
log.Warningf("security_policy %q not found; using fallback policy (deny-all)", securityPolicy)
log.Warningf("security-policy %q not found; using fallback policy (deny-all)", securityPolicy)
currentPolicy = denyAllPolicy{}
}

4
go/acl/acl_test.go
View File

@ -106,8 +106,8 @@ func TestRegisterFlags(t *testing.T) {
RegisterFlags(testFs)
securityPolicyFlag := testFs.Lookup("security_policy")
assert.NotNil(t, securityPolicyFlag, "no security_policy flag is registered")
securityPolicyFlag := testFs.Lookup("security-policy")
assert.NotNil(t, securityPolicyFlag, "no security-policy flag is registered")
// Check the default value of the flag
want := "test"

2
go/acl/deny_all_policy.go
View File

@ -21,7 +21,7 @@ import (
"net/http"
)
var errDenyAll = errors.New("not allowed: deny-all security_policy enforced")
var errDenyAll = errors.New("not allowed: deny-all security-policy enforced")
// denyAllPolicy rejects all access.
type denyAllPolicy struct{}

2
go/acl/read_only_policy.go
View File

@ -21,7 +21,7 @@ import (
"net/http"
)
var errReadOnly = errors.New("not allowed: read-only security_policy enforced")
var errReadOnly = errors.New("not allowed: read-only security-policy enforced")
// readOnlyPolicy allows DEBUGGING and MONITORING roles for everyone,
// while denying any other roles (e.g. ADMIN) for everyone.

4
go/cmd/mysqlctl/command/init.go
View File

@ -33,8 +33,8 @@ var Init = &cobra.Command{
"The MySQL version and flavor will be auto-detected, with a minimal configuration file applied.",
Example: `mysqlctl \
--alsologtostderr \
--tablet_uid 101 \
--mysql_port 12345 \
--tablet-uid 101 \
--mysql-port 12345 \
init`,
Args: cobra.NoArgs,
RunE: commandInit,

4
go/cmd/mysqlctl/command/init_config.go
View File

@ -31,8 +31,8 @@ var InitConfig = &cobra.Command{
"This command is the same as `init` except the `mysqld` server will not be started.",
Example: `mysqlctl \
--alsologtostderr \
--tablet_uid 101 \
--mysql_port 12345 \
--tablet-uid 101 \
--mysql-port 12345 \
init_config`,
Args: cobra.NoArgs,
RunE: commandInitConfig,

4
go/cmd/mysqlctl/command/reinit_config.go
View File

@ -32,8 +32,8 @@ var ReinitConfig = &cobra.Command{
"This could be helpful to revert configuration changes, or to pick up changes made to the bundled config in newer Vitess versions.",
Example: `mysqlctl \
--alsologtostderr \
--tablet_uid 101 \
--mysql_port 12345 \
--tablet-uid 101 \
--mysql-port 12345 \
reinit_config`,
Args: cobra.NoArgs,
RunE: commandReinitConfig,

7
go/cmd/mysqlctl/command/root.go
View File

@ -27,6 +27,7 @@ import (
"vitess.io/vitess/go/vt/dbconfigs"
"vitess.io/vitess/go/vt/logutil"
"vitess.io/vitess/go/vt/servenv"
"vitess.io/vitess/go/vt/utils"
)
var (
@ -70,9 +71,9 @@ func init() {
servenv.MovePersistentFlagsToCobraCommand(Root)
Root.PersistentFlags().IntVar(&mysqlPort, "mysql_port", mysqlPort, "MySQL port.")
Root.PersistentFlags().Uint32Var(&tabletUID, "tablet_uid", tabletUID, "Tablet UID.")
Root.PersistentFlags().StringVar(&mysqlSocket, "mysql_socket", mysqlSocket, "Path to the mysqld socket file.")
utils.SetFlagIntVar(Root.PersistentFlags(), &mysqlPort, "mysql-port", mysqlPort, "MySQL port.")
utils.SetFlagUint32Var(Root.PersistentFlags(), &tabletUID, "tablet-uid", tabletUID, "Tablet UID.")
utils.SetFlagStringVar(Root.PersistentFlags(), &mysqlSocket, "mysql-socket", mysqlSocket, "Path to the mysqld socket file.")
acl.RegisterFlags(Root.PersistentFlags())

2
go/cmd/mysqlctl/command/shutdown.go
View File

@ -31,7 +31,7 @@ var Shutdown = &cobra.Command{
Short: "Shuts down mysqld, without removing any files.",
Long: "Stop a `mysqld` instance that was previously started with `init` or `start`.\n\n" +
"For large `mysqld` instances, you may need to extend the `wait_time` to shutdown cleanly.",
Example: `mysqlctl --tablet_uid 101 --alsologtostderr shutdown`,
Example: `mysqlctl --tablet-uid 101 --alsologtostderr shutdown`,
Args: cobra.NoArgs,
RunE: commandShutdown,
}

2
go/cmd/mysqlctl/command/start.go
View File

@ -31,7 +31,7 @@ var Start = &cobra.Command{
Use: "start",
Short: "Starts mysqld on an already 'init'-ed directory.",
Long: "Resume an existing `mysqld` instance that was previously bootstrapped with `init` or `init_config`",
Example: `mysqlctl --tablet_uid 101 --alsologtostderr start`,
Example: `mysqlctl --tablet-uid 101 --alsologtostderr start`,
Args: cobra.NoArgs,
RunE: commandStart,
}

2
go/cmd/mysqlctl/command/teardown.go
View File

@ -33,7 +33,7 @@ var Teardown = &cobra.Command{
"This is a destructive operation.\n" +
"{{</ warning >}}\n\n" +
"Shuts down a `mysqld` instance and removes its data directory.",
Example: `mysqlctl --tablet_uid 101 --alsologtostderr teardown`,
Example: `mysqlctl --tablet-uid 101 --alsologtostderr teardown`,
Args: cobra.NoArgs,
RunE: commandTeardown,
}

11
go/cmd/mysqlctld/cli/mysqlctld.go
View File

@ -34,6 +34,7 @@ import (
"vitess.io/vitess/go/vt/logutil"
"vitess.io/vitess/go/vt/mysqlctl"
"vitess.io/vitess/go/vt/servenv"
"vitess.io/vitess/go/vt/utils"
)
var (
@ -63,8 +64,8 @@ var (
"To enable communication with a `vttablet`, the server must be configured to receive gRPC messages on a unix domain socket.",
Example: `mysqlctld \
--log_dir=${VTDATAROOT}/logs \
--tablet_uid=100 \
--mysql_port=17100 \
--tablet-uid=100 \
--mysql-port=17100 \
--socket_file=/path/to/socket_file`,
Args: cobra.NoArgs,
Version: servenv.AppVersion.String(),
@ -91,9 +92,9 @@ func init() {
servenv.MoveFlagsToCobraCommand(Main)
Main.Flags().IntVar(&mysqlPort, "mysql_port", mysqlPort, "MySQL port")
Main.Flags().Uint32Var(&tabletUID, "tablet_uid", tabletUID, "Tablet UID")
Main.Flags().StringVar(&mysqlSocket, "mysql_socket", mysqlSocket, "Path to the mysqld socket file")
utils.SetFlagIntVar(Main.Flags(), &mysqlPort, "mysql-port", mysqlPort, "MySQL port")
utils.SetFlagUint32Var(Main.Flags(), &tabletUID, "tablet-uid", tabletUID, "Tablet UID")
utils.SetFlagStringVar(Main.Flags(), &mysqlSocket, "mysql-socket", mysqlSocket, "Path to the mysqld socket file")
Main.Flags().DurationVar(&waitTime, "wait_time", waitTime, "How long to wait for mysqld startup")
Main.Flags().StringVar(&initDBSQLFile, "init_db_sql_file", initDBSQLFile, "Path to .sql file to run after mysqld initialization")
Main.Flags().DurationVar(&shutdownWaitTime, "shutdown-wait-time", shutdownWaitTime, "How long to wait for mysqld shutdown")

3
go/cmd/vtadmin/main.go
View File

@ -28,6 +28,7 @@ import (
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/logutil"
"vitess.io/vitess/go/vt/servenv"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vtadmin"
"vitess.io/vitess/go/vt/vtadmin/cache"
"vitess.io/vitess/go/vt/vtadmin/cluster"
@ -173,7 +174,7 @@ func main() {
// Tracing flags
trace.RegisterFlags(rootCmd.Flags()) // defined in go/vt/trace
rootCmd.Flags().BoolVar(&opts.EnableTracing, "grpc-tracing", false, "whether to enable tracing on the gRPC server")
utils.SetFlagBoolVar(rootCmd.Flags(), &opts.EnableTracing, "grpc-tracing", false, "whether to enable tracing on the gRPC server")
rootCmd.Flags().BoolVar(&httpOpts.EnableTracing, "http-tracing", false, "whether to enable tracing on the HTTP server")
// gRPC server flags

11
go/cmd/vtbackup/cli/vtbackup.go
View File

@ -46,6 +46,7 @@ import (
"vitess.io/vitess/go/vt/servenv"
"vitess.io/vitess/go/vt/topo"
"vitess.io/vitess/go/vt/topo/topoproto"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vterrors"
_ "vitess.io/vitess/go/vt/vttablet/grpctmclient"
"vitess.io/vitess/go/vt/vttablet/tmclient"
@ -209,15 +210,15 @@ func init() {
Main.Flags().BoolVar(&upgradeSafe, "upgrade-safe", upgradeSafe, "Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades.")
// vttablet-like flags
Main.Flags().StringVar(&initDbNameOverride, "init_db_name_override", initDbNameOverride, "(init parameter) override the name of the db used by vttablet")
Main.Flags().StringVar(&initKeyspace, "init_keyspace", initKeyspace, "(init parameter) keyspace to use for this tablet")
Main.Flags().StringVar(&initShard, "init_shard", initShard, "(init parameter) shard to use for this tablet")
utils.SetFlagStringVar(Main.Flags(), &initDbNameOverride, "init-db-name-override", initDbNameOverride, "(init parameter) override the name of the db used by vttablet")
utils.SetFlagStringVar(Main.Flags(), &initKeyspace, "init-keyspace", initKeyspace, "(init parameter) keyspace to use for this tablet")
utils.SetFlagStringVar(Main.Flags(), &initShard, "init-shard", initShard, "(init parameter) shard to use for this tablet")
Main.Flags().IntVar(&concurrency, "concurrency", concurrency, "(init restore parameter) how many concurrent files to restore at once")
Main.Flags().StringVar(&incrementalFromPos, "incremental_from_pos", incrementalFromPos, "Position, or name of backup from which to create an incremental backup. Default: empty. If given, then this backup becomes an incremental backup from given position or given backup. If value is 'auto', this backup will be taken from the last successful backup position.")
// mysqlctld-like flags
Main.Flags().IntVar(&mysqlPort, "mysql_port", mysqlPort, "mysql port")
Main.Flags().StringVar(&mysqlSocket, "mysql_socket", mysqlSocket, "path to the mysql socket")
utils.SetFlagIntVar(Main.Flags(), &mysqlPort, "mysql-port", mysqlPort, "MySQL port")
utils.SetFlagStringVar(Main.Flags(), &mysqlSocket, "mysql-socket", mysqlSocket, "Path to the mysqld socket file")
Main.Flags().DurationVar(&mysqlTimeout, "mysql_timeout", mysqlTimeout, "how long to wait for mysqld startup")
Main.Flags().DurationVar(&mysqlShutdownTimeout, "mysql-shutdown-timeout", mysqlShutdownTimeout, "how long to wait for mysqld shutdown")
Main.Flags().StringVar(&initDBSQLFile, "init_db_sql_file", initDBSQLFile, "path to .sql file to run after mysql_install_db")

16
go/cmd/vtcombo/cli/main.go
View File

@ -44,6 +44,7 @@ import (
"vitess.io/vitess/go/vt/topo/memorytopo"
"vitess.io/vitess/go/vt/topo/topoproto"
"vitess.io/vitess/go/vt/topotools"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vtcombo"
"vitess.io/vitess/go/vt/vtctld"
"vitess.io/vitess/go/vt/vtenv"
@ -106,7 +107,7 @@ func init() {
Main.Flags().StringVar(&schemaDir, "schema_dir", schemaDir, "Schema base directory. Should contain one directory per keyspace, with a vschema.json file if necessary.")
Main.Flags().BoolVar(&startMysql, "start_mysql", startMysql, "Should vtcombo also start mysql")
Main.Flags().IntVar(&mysqlPort, "mysql_port", mysqlPort, "mysql port")
utils.SetFlagIntVar(Main.Flags(), &mysqlPort, "mysql-port", mysqlPort, "mysql port")
Main.Flags().BoolVar(&externalTopoServer, "external_topo_server", externalTopoServer, "Should vtcombo use an external topology server instead of starting its own in-memory topology server. "+
"If true, vtcombo will use the flags defined in topo/server.go to open topo server")
Main.Flags().StringVar(&plannerName, "planner-version", plannerName, "Sets the default planner to use when the session has not changed it. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right")
@ -120,11 +121,11 @@ func init() {
Main.Flags().Var(vttest.TextTopoData(&tpb), "proto_topo", "vttest proto definition of the topology, encoded in compact text format. See vttest.proto for more information.")
Main.Flags().Var(vttest.JSONTopoData(&tpb), "json_topo", "vttest proto definition of the topology, encoded in json format. See vttest.proto for more information.")
Main.Flags().Var((*topoproto.TabletTypeListFlag)(&tabletTypesToWait), "tablet_types_to_wait", "Wait till connected for specified tablet types during Gateway initialization. Should be provided as a comma-separated set of tablet types.")
utils.SetFlagVar(Main.Flags(), (*topoproto.TabletTypeListFlag)(&tabletTypesToWait), "tablet-types-to-wait", "Wait till connected for specified tablet types during Gateway initialization. Should be provided as a comma-separated set of tablet types.")
// We're going to force the value later, so don't even bother letting the
// user know about this flag.
Main.Flags().MarkHidden("tablet_protocol")
Main.Flags().MarkHidden("tablet-protocol")
srvTopoCounts = stats.NewCountersWithSingleLabel("ResilientSrvTopoServer", "Resilient srvtopo server operations", "type")
}
@ -241,10 +242,11 @@ func run(cmd *cobra.Command, args []string) (err error) {
// Tablet configuration and init.
// Send mycnf as nil because vtcombo won't do backups and restores.
//
// Also force the `--tablet_manager_protocol` and `--tablet_protocol` flags
// Also force the `--tablet-manager-protocol` and `--tablet-protocol` flags
// to be the "internal" protocol that InitTabletMap registers.
cmd.Flags().Set("tablet_manager_protocol", "internal")
cmd.Flags().Set("tablet_protocol", "internal")
cmd.Flags().Set("tablet-manager-protocol", "internal")
cmd.Flags().Set("tablet-protocol", "internal")
uid, err := vtcombo.InitTabletMap(env, ts, &tpb, mysqld, &dbconfigs.GlobalDBConfigs, schemaDir, startMysql, srvTopoCounts)
if err != nil {
// ensure we start mysql in the event we fail here
@ -320,7 +322,7 @@ func run(cmd *cobra.Command, args []string) (err error) {
}
if len(tabletTypes) == 0 {
log.Exitf("tablet_types_to_wait should contain at least one serving tablet type")
log.Exitf("tablet-types-to-wait should contain at least one serving tablet type")
}
} else {
tabletTypes = append(tabletTypes, topodatapb.TabletType_PRIMARY, topodatapb.TabletType_REPLICA, topodatapb.TabletType_RDONLY)

14
go/cmd/vtctld/cli/cli.go
View File

@ -37,17 +37,17 @@ It is usually the first Vitess component to be started after a valid global topo
For the last several releases, vtctld has been transitioning to a newer gRPC service for well-typed cluster management requests.
This is **required** to use programs such as vtadmin and vtctldclient, and The old API and service are deprecated and will be removed in a future release.
To enable this newer service, include "grpc-vtctld" in the --service_map argument.
To enable this newer service, include "grpc-vtctld" in the --service-map argument.
This is demonstrated in the example usage below.`,
Example: `vtctld \
--topo_implementation etcd2 \
--topo_global_server_address localhost:2379 \
--topo_global_root /vitess/ \
--service_map 'grpc-vtctl,grpc-vtctld' \
--backup_storage_implementation file \
--topo-implementation etcd2 \
--topo-global-server-address localhost:2379 \
--topo-global-root /vitess/ \
--service-map 'grpc-vtctl,grpc-vtctld' \
--backup-storage-implementation file \
--file_backup_storage_root $VTDATAROOT/backups \
--port 15000 \
--grpc_port 15999`,
--grpc-port 15999`,
Args: cobra.NoArgs,
Version: servenv.AppVersion.String(),
PreRunE: servenv.CobraPreRunE,

3
go/cmd/vtctldclient/command/vreplication/materialize/materialize.go
View File

@ -25,6 +25,7 @@ import (
"vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/common"
"vitess.io/vitess/go/mysql/config"
"vitess.io/vitess/go/vt/topo/topoproto"
"vitess.io/vitess/go/vt/utils"
vtctldatapb "vitess.io/vitess/go/vt/proto/vtctldata"
)
@ -89,7 +90,7 @@ func registerCommands(root *cobra.Command) {
create.MarkFlagRequired("source-keyspace")
create.Flags().Var(&createOptions.TableSettings, "table-settings", "A JSON array defining what tables to materialize using what select statements. See the --help output for more details.")
create.Flags().BoolVar(&common.CreateOptions.StopAfterCopy, "stop-after-copy", false, "Stop the workflow after it's finished copying the existing rows and before it starts replicating changes.")
create.Flags().StringVar(&common.CreateOptions.MySQLServerVersion, "mysql_server_version", fmt.Sprintf("%s-Vitess", config.DefaultMySQLVersion), "Configure the MySQL version to use for example for the parser.")
utils.SetFlagStringVar(create.Flags(), &common.CreateOptions.MySQLServerVersion, "mysql-server-version", fmt.Sprintf("%s-Vitess", config.DefaultMySQLVersion), "Configure the MySQL version to use for example for the parser.")
create.Flags().IntVar(&common.CreateOptions.TruncateUILen, "sql-max-length-ui", 512, "truncate queries in debug UIs to the given length (default 512)")
create.Flags().IntVar(&common.CreateOptions.TruncateErrLen, "sql-max-length-errors", 0, "truncate queries in error logs to the given length (default unlimited)")
create.Flags().StringSliceVarP(&common.CreateOptions.ReferenceTables, "reference-tables", "r", nil, "Used to specify the reference tables to materialize on every target shard.")

30
go/cmd/vtgate/cli/cli.go
View File

@ -31,6 +31,7 @@ import (
"vitess.io/vitess/go/vt/srvtopo"
"vitess.io/vitess/go/vt/topo"
"vitess.io/vitess/go/vt/topo/topoproto"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vtenv"
"vitess.io/vitess/go/vt/vterrors"
"vitess.io/vitess/go/vt/vtgate"
@ -53,22 +54,22 @@ var (
### Key Options
` +
"\n* `--srv_topo_cache_ttl`: There may be instances where you will need to increase the cached TTL from the default of 1 second to a higher number:\n" +
"\n* `--srv-topo-cache-ttl`: There may be instances where you will need to increase the cached TTL from the default of 1 second to a higher number:\n" +
` * You may want to increase this option if you see that your topo leader goes down and keeps your queries waiting for a few seconds.`,
Example: `vtgate \
--topo_implementation etcd2 \
--topo_global_server_address localhost:2379 \
--topo_global_root /vitess/global \
--topo-implementation etcd2 \
--topo-global-server-address localhost:2379 \
--topo-global-root /vitess/global \
--log_dir $VTDATAROOT/tmp \
--port 15001 \
--grpc_port 15991 \
--mysql_server_port 15306 \
--grpc-port 15991 \
--mysql-server-port 15306 \
--cell test \
--cells_to_watch test \
--tablet_types_to_wait PRIMARY,REPLICA \
--service_map 'grpc-vtgateservice' \
--pid_file $VTDATAROOT/tmp/vtgate.pid \
--mysql_auth_server_impl none`,
--tablet-types-to-wait PRIMARY,REPLICA \
--service-map 'grpc-vtgateservice' \
--pid-file $VTDATAROOT/tmp/vtgate.pid \
--mysql-auth-server-impl none`,
Args: cobra.NoArgs,
Version: servenv.AppVersion.String(),
PreRunE: servenv.CobraPreRunE,
@ -162,7 +163,7 @@ func run(cmd *cobra.Command, args []string) error {
}
if len(tabletTypes) == 0 {
return fmt.Errorf("tablet_types_to_wait must contain at least one serving tablet type")
return fmt.Errorf("tablet-types-to-wait must contain at least one serving tablet type")
}
err := CheckCellFlags(ctx, resilientServer, cell, vtgate.CellsToWatch)
@ -208,8 +209,11 @@ func init() {
acl.RegisterFlags(Main.Flags())
Main.Flags().StringVar(&cell, "cell", cell, "cell to use")
Main.Flags().Var((*topoproto.TabletTypeListFlag)(&tabletTypesToWait), "tablet_types_to_wait", "Wait till connected for specified tablet types during Gateway initialization. Should be provided as a comma-separated set of tablet types.")
utils.SetFlagVar(Main.Flags(), (*topoproto.TabletTypeListFlag)(&tabletTypesToWait), "tablet-types-to-wait", "Wait till connected for specified tablet types during Gateway initialization. Should be provided as a comma-separated set of tablet types.")
Main.Flags().StringVar(&plannerName, "planner-version", plannerName, "Sets the default planner to use when the session has not changed it. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right")
Main.MarkFlagRequired("tablet_types_to_wait")
// Support both variants until v25
// Main.MarkFlagRequired("tablet-types-to-wait")
Main.MarkFlagsOneRequired("tablet-types-to-wait", "tablet_types_to_wait")
}

6
go/cmd/vtorc/cli/cli.go
View File

@ -34,9 +34,9 @@ var (
Use: "vtorc",
Short: "VTOrc is the automated fault detection and repair tool in Vitess.",
Example: `vtorc \
--topo_implementation etcd2 \
--topo_global_server_address localhost:2379 \
--topo_global_root /vitess/global \
--topo-implementation etcd2 \
--topo-global-server-address localhost:2379 \
--topo-global-root /vitess/global \
--log_dir $VTDATAROOT/tmp \
--port 15000 \
--instance-poll-time "1s" \

20
go/cmd/vttablet/cli/cli.go
View File

@ -81,20 +81,20 @@ Even if a MySQL is external, you can still make vttablet perform some management
` +
"* `--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.\n" +
"* `--replication_connect_retry`: This value is give to mysql when it connects a replica to the primary as the retry duration parameter.\n" +
"* `--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.\n",
"* `--replication-connect-retry`: This value is give to mysql when it connects a replica to the primary as the retry duration parameter.\n" +
"* `--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.\n",
Example: `
vttablet \
--topo_implementation etcd2 \
--topo_global_server_address localhost:2379 \
--topo_global_root /vitess/ \
--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 \
--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'` + "\n\n`$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.",
--grpc-port $grpc_port \
--service-map 'grpc-queryservice,grpc-tabletmanager,grpc-updatestream'` + "\n\n`$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.",
Args: cobra.NoArgs,
Version: servenv.AppVersion.String(),
PreRunE: servenv.CobraPreRunE,

25
go/cmd/vttablet/cli/cli_test.go
View File

@ -25,6 +25,7 @@ import (
"vitess.io/vitess/go/vt/topo"
"vitess.io/vitess/go/vt/topo/memorytopo"
"vitess.io/vitess/go/vt/utils"
)
// TestRunFailsToStartTabletManager tests the code path in 'run' where we fail to start the TabletManager
@ -42,13 +43,27 @@ func TestRunFailsToStartTabletManager(t *testing.T) {
os.Args = append([]string{}, args...)
})
os.Args = []string{"vttablet",
"--topo_implementation", "test", "--topo_global_server_address", "localhost", "--topo_global_root", "cell",
"--db_host", "localhost", "--db_port", "3306",
"--tablet-path", "cell-1", "--init_keyspace", "ks", "--init_shard", "0", "--init_tablet_type", "replica",
"--restore_from_backup",
flags := make(map[string]string)
utils.SetFlagVariantsForTests(flags, "--topo-implementation", "test")
utils.SetFlagVariantsForTests(flags, "--topo-global-server-address", "localhost")
utils.SetFlagVariantsForTests(flags, "--topo-global-root", "cell")
utils.SetFlagVariantsForTests(flags, "--db-host", "localhost")
utils.SetFlagVariantsForTests(flags, "--db-port", "3306")
utils.SetFlagVariantsForTests(flags, "--init-keyspace", "ks")
utils.SetFlagVariantsForTests(flags, "--init-shard", "0")
utils.SetFlagVariantsForTests(flags, "--init-tablet-type", "replica")
var flagArgs []string
for flag, value := range flags {
flagArgs = append(flagArgs, flag, value)
}
flagArgs = append(flagArgs,
"--tablet-path", "cell-1", "--restore_from_backup",
)
os.Args = append([]string{"vttablet"}, flagArgs...)
// Creating and canceling the context so that pending tasks in tm_init gets canceled before we close the topo server
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

17
go/cmd/vttestserver/cli/main.go
View File

@ -34,6 +34,7 @@ import (
"vitess.io/vitess/go/acl"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/servenv"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vttest"
vttestpb "vitess.io/vitess/go/vt/proto/vttest"
@ -146,35 +147,35 @@ func New() (cmd *cobra.Command) {
" when LocalCluster.TearDown() is called. This is useful for running"+
" vttestserver as a database container in local developer environments. Note"+
" that db migration files (--schema_dir option) and seeding of"+
" random data (--initialize_with_random_data option) will only run during"+
" random data (--initialize-with-random-data option) will only run during"+
" cluster startup if the data directory does not already exist. "+
" Changes to VSchema are persisted across cluster restarts using a simple"+
" watcher if the --data_dir argument is specified.")
cmd.Flags().BoolVar(&doSeed, "initialize_with_random_data", false,
utils.SetFlagBoolVar(cmd.Flags(), &doSeed, "initialize-with-random-data", false,
"If this flag is each table-shard will be initialized"+
" with random data. See also the 'rng_seed' and 'min_shard_size'"+
" and 'max_shard_size' flags.")
cmd.Flags().IntVar(&seed.RngSeed, "rng_seed", 123,
"The random number generator seed to use when initializing"+
" with random data (see also --initialize_with_random_data)."+
" with random data (see also --initialize-with-random-data)."+
" Multiple runs with the same seed will result with the same"+
" initial data.")
cmd.Flags().IntVar(&seed.MinSize, "min_table_shard_size", 1000,
"The minimum number of initial rows in a table shard. Ignored if"+
"--initialize_with_random_data is false. The actual number is chosen"+
"--initialize-with-random-data is false. The actual number is chosen"+
" randomly.")
cmd.Flags().IntVar(&seed.MaxSize, "max_table_shard_size", 10000,
"The maximum number of initial rows in a table shard. Ignored if"+
"--initialize_with_random_data is false. The actual number is chosen"+
"--initialize-with-random-data is false. The actual number is chosen"+
" randomly")
cmd.Flags().Float64Var(&seed.NullProbability, "null_probability", 0.1,
"The probability to initialize a field with 'NULL' "+
" if --initialize_with_random_data is true. Only applies to fields"+
" if --initialize-with-random-data is true. Only applies to fields"+
" that can contain NULL values.")
cmd.Flags().StringVar(&config.MySQLBindHost, "mysql_bind_host", "localhost",
@ -208,7 +209,7 @@ func New() (cmd *cobra.Command) {
cmd.Flags().StringVar(&config.TransactionMode, "transaction_mode", "MULTI", "Transaction mode MULTI (default), SINGLE or TWOPC ")
cmd.Flags().DurationVar(&config.TransactionTimeout, "queryserver-config-transaction-timeout", 30*time.Second, "query server transaction timeout, a transaction will be killed if it takes longer than this value")
cmd.Flags().StringVar(&config.TabletHostName, "tablet_hostname", "localhost", "The hostname to use for the tablet otherwise it will be derived from OS' hostname")
utils.SetFlagStringVar(cmd.Flags(), &config.TabletHostName, "tablet-hostname", "localhost", "The hostname to use for the tablet otherwise it will be derived from OS' hostname")
cmd.Flags().StringVar(&config.VSchemaDDLAuthorizedUsers, "vschema_ddl_authorized_users", "", "Comma separated list of users authorized to execute vschema ddl operations via vtgate")
@ -221,7 +222,7 @@ func New() (cmd *cobra.Command) {
cmd.Flags().StringVar(&config.ExternalTopoGlobalServerAddress, "external_topo_global_server_address", "", "the address of the global topology server for vtcombo process")
cmd.Flags().StringVar(&config.ExternalTopoGlobalRoot, "external_topo_global_root", "", "the path of the global topology data in the global topology server for vtcombo process")
cmd.Flags().DurationVar(&config.VtgateTabletRefreshInterval, "tablet_refresh_interval", 10*time.Second, "Interval at which vtgate refreshes tablet information from topology server.")
utils.SetFlagDurationVar(cmd.Flags(), &config.VtgateTabletRefreshInterval, "tablet-refresh-interval", 10*time.Second, "Interval at which vtgate refreshes tablet information from topology server.")
cmd.Flags().BoolVar(&doCreateTCPUser, "initialize-with-vt-dba-tcp", false, "If this flag is enabled, MySQL will be initialized with an additional user named vt_dba_tcp, who will have access via TCP/IP connection.")

23
go/cmd/vttestserver/cli/main_test.go
View File

@ -38,6 +38,7 @@ import (
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/logutil"
"vitess.io/vitess/go/vt/tlstest"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vtctl/vtctlclient"
"vitess.io/vitess/go/vt/vttest"
@ -302,14 +303,14 @@ func TestMtlsAuth(t *testing.T) {
// When cluster starts it will apply SQL and VSchema migrations in the configured schema_dir folder
// With mtls authorization enabled, the authorized CN must match the certificate's CN
cluster, err := startCluster(
"--grpc_auth_mode=mtls",
fmt.Sprintf("--grpc_key=%s", key),
fmt.Sprintf("--grpc_cert=%s", cert),
fmt.Sprintf("--grpc_ca=%s", caCert),
utils.GetFlagVariantForTests("--grpc-auth-mode")+"=mtls",
fmt.Sprintf("%s=%s", utils.GetFlagVariantForTests("--grpc-key"), key),
fmt.Sprintf("%s=%s", utils.GetFlagVariantForTests("--grpc-cert"), cert),
fmt.Sprintf("%s=%s", utils.GetFlagVariantForTests("--grpc-ca"), caCert),
fmt.Sprintf("--vtctld_grpc_key=%s", clientKey),
fmt.Sprintf("--vtctld_grpc_cert=%s", clientCert),
fmt.Sprintf("--vtctld_grpc_ca=%s", caCert),
fmt.Sprintf("--grpc_auth_mtls_allowed_substrings=%s", "CN=ClientApp"))
fmt.Sprintf("%s=%s", utils.GetFlagVariantForTests("--grpc-auth-mtls-allowed-substrings"), "CN=ClientApp"))
require.NoError(t, err)
defer func() {
cluster.PersistentMode = false // Cleanup the tmpdir as we're done
@ -344,14 +345,14 @@ func TestMtlsAuthUnauthorizedFails(t *testing.T) {
// For mtls authorization failure by providing a client certificate with different CN thant the
// authorized in the configuration
cluster, err := startCluster(
"--grpc_auth_mode=mtls",
fmt.Sprintf("--grpc_key=%s", key),
fmt.Sprintf("--grpc_cert=%s", cert),
fmt.Sprintf("--grpc_ca=%s", caCert),
utils.GetFlagVariantForTests("--grpc-auth-mode")+"=mtls",
fmt.Sprintf("%s=%s", utils.GetFlagVariantForTests("--grpc-key"), key),
fmt.Sprintf("%s=%s", utils.GetFlagVariantForTests("--grpc-cert"), cert),
fmt.Sprintf("%s=%s", utils.GetFlagVariantForTests("--grpc-ca"), caCert),
fmt.Sprintf("--vtctld_grpc_key=%s", clientKey),
fmt.Sprintf("--vtctld_grpc_cert=%s", clientCert),
fmt.Sprintf("--vtctld_grpc_ca=%s", caCert),
fmt.Sprintf("--grpc_auth_mtls_allowed_substrings=%s", "CN=ClientApp"))
fmt.Sprintf("--grpc-auth-mtls-allowed-substrings=%s", "CN=ClientApp"))
defer cluster.TearDown()
require.Error(t, err)
@ -376,7 +377,7 @@ var clusterKeyspaces = []string{
func startCluster(flags ...string) (cluster vttest.LocalCluster, err error) {
args := []string{"vttestserver"}
schemaDirArg := "--schema_dir=data/schema"
tabletHostname := "--tablet_hostname=localhost"
tabletHostname := fmt.Sprintf("%s=localhost", utils.GetFlagVariantForTests("--tablet-hostname"))
keyspaceArg := "--keyspaces=" + strings.Join(clusterKeyspaces, ",")
numShardsArg := "--num_shards=2,2"
vschemaDDLAuthorizedUsers := "--vschema_ddl_authorized_users=%"

32
go/flags/endtoend/count_flags.sh Executable file
View File

@ -0,0 +1,32 @@
# !/bin/bash
underscore_count=0
dash_count=0
for file in *.txt; do
reading_flags=0
while IFS= read -r line; do
if [[ "$line" == "Flags:" || "$line" == "Usage of vtctlclient:" ]]; then
reading_flags=1
continue
fi
if [[ $reading_flags -eq 1 ]]; then
flag=$(echo "$line" | awk '{print $1}')
if [[ "$flag" == --* ]]; then
flag_name="${flag:2}"
[[ "$flag_name" == *_* ]] && ((underscore_count++))
[[ "$flag_name" == *-* ]] && ((dash_count++))
fi
fi
done < "$file"
done
echo "-------------------------------------"
echo "Total Flags with underscores (_): $underscore_count"
echo "Total Flags with dashes (-): $dash_count"

70
go/flags/endtoend/mysqlctl.txt
View File

@ -29,6 +29,9 @@ Flags:
--config-path strings Paths to search for config files in. (default [{{ .Workdir }}])
--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).
--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
@ -40,57 +43,54 @@ Flags:
--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_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_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_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_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.
--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-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-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)
-h, --help help for mysqlctl
--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)
--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)
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logtostderr log to standard error instead of files
--max-stack-size int configure the maximum stack size in bytes (default 67108864)
--mysql_port int MySQL port. (default 3306)
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--mysql_socket string Path to the mysqld socket file.
--mysql-port int MySQL port. (default 3306)
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-Vitess")
--mysql-socket string Path to the mysqld socket file.
--mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default "grpc")
--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)
--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)
--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)
--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)
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s)
--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)
--service_map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--replication-connect-retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s)
--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)
--service-map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--socket_file string Local unix socket file to listen on
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class
--tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
--tablet_uid uint32 Tablet UID. (default 41983)
--tablet-dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
--tablet-uid uint32 Tablet UID. (default 41983)
--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

124
go/flags/endtoend/mysqlctld.txt
View File

@ -14,8 +14,8 @@ Usage:
Examples:
mysqlctld \
--log_dir=${VTDATAROOT}/logs \
--tablet_uid=100 \
--mysql_port=17100 \
--tablet-uid=100 \
--mysql-port=17100 \
--socket_file=/path/to/socket_file
Flags:
@ -30,6 +30,9 @@ Flags:
--config-path strings Paths to search for config files in. (default [{{ .Workdir }}])
--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).
--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
@ -41,85 +44,82 @@ Flags:
--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_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_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_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_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.
--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-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-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)
--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_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_enable_optional_tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--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_port int Port to listen on for gRPC calls. If zero, do not listen.
--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)
--grpc-enable-optional-tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--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-port int Port to listen on for gRPC calls. If zero, do not listen.
--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)
-h, --help help for mysqlctld
--init_db_sql_file string Path to .sql file to run after mysqld initialization
--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)
--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)
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logtostderr log to standard error instead of files
--max-stack-size int configure the maximum stack size in bytes (default 67108864)
--mysql_port int MySQL port (default 3306)
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--mysql_socket string Path to the mysqld socket file
--mysql-port int MySQL port (default 3306)
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-Vitess")
--mysql-socket string Path to the mysqld socket file
--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 5m10s)
--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)
--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 5m10s)
--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
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s)
--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)
--service_map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--replication-connect-retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s)
--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)
--service-map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--shutdown-wait-time duration How long to wait for mysqld shutdown (default 5m0s)
--socket_file string Local unix socket file to listen on
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class
--tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
--tablet_uid uint32 Tablet UID (default 41983)
--tablet-dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
--tablet-uid uint32 Tablet UID (default 41983)
--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

18
go/flags/endtoend/topo2topo.txt
View File

@ -21,21 +21,21 @@ Flags:
--from_implementation string topology implementation to copy data from
--from_root string topology server root to copy data from
--from_server string topology server address to copy data from
--grpc_enable_tracing Enable gRPC tracing.
--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_prometheus Enable gRPC monitoring with Prometheus.
--grpc-enable-tracing Enable gRPC tracing.
--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-prometheus Enable gRPC monitoring with Prometheus.
-h, --help help for topo2topo
--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)
--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)
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logtostderr log to standard error instead of files
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--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)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--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)
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--to_implementation string topology implementation to copy data to
--to_root string topology server root to copy data to

12
go/flags/endtoend/vtaclcheck.txt
View File

@ -13,17 +13,17 @@ Flags:
--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).
-h, --help help for vtaclcheck
--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)
--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)
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logtostderr log to standard error instead of files
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--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)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--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)
--static-auth-file string The path of the auth_server_static JSON file to check
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--v Level log level for V logs

280
go/flags/endtoend/vtbackup.txt
View File

@ -50,23 +50,23 @@ Usage:
Flags:
--allow_first_backup Allow this job to take the first backup of an existing shard.
--alsologtostderr log to standard error as well as files
--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)
--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.
--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)
--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)
--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)
@ -77,7 +77,19 @@ Flags:
--config-path strings Paths to search for config files in. (default [{{ .Workdir }}])
--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).
--consul_auth_static_file string JSON File to read the topos/tokens from.
--consul-auth-static-file string JSON File to read the topos/tokens from.
--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
@ -89,99 +101,89 @@ Flags:
--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_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_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.
--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.
--detach detached mode - run backups detached from the terminal
--disable-redo-log Disable InnoDB redo log during replication-from-primary phase of backup.
--emit_stats If set, emit stats to push-based monitoring and stats backends
--emit-stats If set, emit stats to push-based monitoring and stats backends
--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.
--file_backup_storage_root string Root directory for the file backup storage.
--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.
--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-static-client-creds string When using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server.
--grpc-compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
--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_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_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
--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_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_prometheus Enable gRPC monitoring with Prometheus.
--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-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-prometheus Enable gRPC monitoring with Prometheus.
-h, --help help for vtbackup
--incremental_from_pos string Position, or name of backup from which to create an incremental backup. Default: empty. If given, then this backup becomes an incremental backup from given position or given backup. If value is 'auto', this backup will be taken from the last successful backup position.
--init_db_name_override string (init parameter) override the name of the db used by vttablet
--init-db-name-override string (init parameter) override the name of the db used by vttablet
--init-keyspace string (init parameter) keyspace to use for this tablet
--init-shard string (init parameter) shard to use for this tablet
--init_db_sql_file string path to .sql file to run after mysql_install_db
--init_keyspace string (init parameter) keyspace to use for this tablet
--init_shard string (init parameter) shard to use for this tablet
--initial_backup Instead of restoring from backup, initialize an empty database with the provided init_db_sql_file and upload a backup of that for the shard, if the shard has no backups yet. This can be used to seed a brand new shard with an initial, empty backup. If any backups already exist for the shard, this will be considered a successful no-op. This can only be done before the shard exists in topology (i.e. before any tablets are deployed).
--keep-alive-timeout duration Wait until timeout elapses after a successful backup before shutting down.
--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)
--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)
--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-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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--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.
--min_backup_interval duration Only take a new backup if it's been at least this long since the most recent backup.
--min_retention_count int Always keep at least this many of the most recent backups in this backup storage location, even if some are older than the min_retention_time. This must be at least 1 since a backup must always exist to allow new backups to be made (default 1)
--min_retention_time duration Keep each old backup for at least this long before removing it. Set to 0 to disable pruning of old backups.
--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_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_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
--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-port int MySQL port (default 3306)
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-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")
@ -189,71 +191,69 @@ Flags:
--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 how long to wait for mysqld shutdown (default 5m0s)
--mysql_port int mysql port (default 3306)
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--mysql_socket string path to the mysql socket
--mysql-socket string Path to the mysqld socket file
--mysql_timeout duration how long to wait for mysqld startup (default 5m0s)
--opentsdb_uri string URI of opentsdb /api/put method
--port int port for the server
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--remote_operation_timeout duration time to wait for a remote operation (default 15s)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--remote-operation-timeout duration time to wait for a remote operation (default 15s)
--restart_before_backup Perform a mysqld clean/full restart after applying binlogs, but before taking the backup. Only makes sense to work around xtrabackup bugs.
--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.
--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)
--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.
--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)
--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)
--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)
--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)
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--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")
--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
--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")
--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
--upgrade-safe Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades.
--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
--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_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.
--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-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.

43
go/flags/endtoend/vtbench.txt
View File

@ -51,40 +51,41 @@ Flags:
--count int Number of queries per thread (default 1000)
--db string Database name to use when connecting / running the queries (e.g. @replica, keyspace, keyspace/shard etc)
--deadline duration Maximum duration for the test run (default 5 minutes) (default 5m0s)
--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_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
--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_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_prometheus Enable gRPC monitoring with Prometheus.
--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-compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
--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-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-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-prometheus Enable gRPC monitoring with Prometheus.
-h, --help help for vtbench
--host string VTGate host(s) in the form 'host1,host2,...'
--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)
--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)
--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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--log-err-stacks log stack traces for errors
--log-rotate-max-size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logtostderr log to standard error instead of files
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-Vitess")
--port int VTGate port
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--protocol string Client protocol, either mysql (default), grpc-vtgate, or grpc-vttablet (default "mysql")
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--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)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--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)
--sql string SQL statement to execute
--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)
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--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-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
--threads int Number of parallel threads to run (default 2)
--unix_socket string VTGate unix socket
--user string Username to connect using mysql (password comes from the db-credentials-file)

40
go/flags/endtoend/vtclient.txt
View File

@ -21,33 +21,53 @@ Flags:
--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).
--count int DMLs only: Number of times each thread executes the query. Useful for simple, sustained load testing. (default 1)
--grpc_enable_tracing Enable gRPC tracing.
--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_prometheus Enable gRPC monitoring with Prometheus.
--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
--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-compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
--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-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-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-prometheus Enable gRPC monitoring with Prometheus.
-h, --help help for vtclient
--jaeger-agent-host string host and port to send spans to. if empty, no tracing will be done
--json Output JSON instead of human-readable table
--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)
--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)
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logtostderr log to standard error instead of files
--max_sequence_id int max sequence ID.
--min_sequence_id int min sequence ID to generate. When max_sequence_id > min_sequence_id, for each query, a number is generated in [min_sequence_id, max_sequence_id) and attached to the end of the bind variables.
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-Vitess")
--parallel int DMLs only: Number of threads executing the same query in parallel. Useful for simple load testing. (default 1)
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--qps int queries per second to throttle each thread at.
--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)
--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)
--server string vtgate server to connect to
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--streaming use a streaming query
--target string keyspace:shard@tablet_type
--timeout duration timeout for queries (default 30s)
--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")
--use_random_sequence use random sequence for generating [min_sequence_id, max_sequence_id)
--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
--vtgate_grpc_ca string the server ca to use to validate servers when connecting
--vtgate_grpc_cert string the cert to use to connect
--vtgate_grpc_crl string the server crl to use to validate server certificates when connecting
--vtgate_grpc_key string the key to use to connect
--vtgate_grpc_server_name string the server name to use to validate server certificate
--vtgate_protocol string how to talk to vtgate (default "grpc")

318
go/flags/endtoend/vtcombo.txt
View File

@ -16,10 +16,10 @@ 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)
--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_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)
--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-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_protocol string the protocol to download binlogs from a vttablet (default "grpc")
@ -32,8 +32,8 @@ Flags:
--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)
--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
--cell string cell to use
--compression-engine-name string compressor engine used for compression. (default "pargzip")
@ -47,9 +47,21 @@ Flags:
--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.
--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
--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
@ -61,42 +73,30 @@ Flags:
--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_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_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.
--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)
--dbddl_plugin string controls how to handle CREATE/DROP DATABASE. use it if you are using your own database provisioning service (default "fail")
@ -106,7 +106,7 @@ Flags:
--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
--emit-stats If set, emit stats to push-based monitoring and stats backends
--enable-consolidator Synonym to -enable_consolidator (default true)
--enable-consolidator-replicas Synonym to -enable_consolidator_replicas
--enable-partial-keyspace-migration (Experimental) Follow shard routing rules: enable only while migrating a keyspace shard by shard. See documentation on Partial MoveTables for more. (default false)
@ -136,61 +136,61 @@ Flags:
--gate_query_cache_memory int gate server query cache size in bytes, maximum amount of memory to be cached. vtgate analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 33554432)
--gc_check_interval duration Interval between garbage collection checks (default 1h0m0s)
--gc_purge_check_interval duration Interval between purge discovery checks (default 1m0s)
--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-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-crl string path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake
--grpc-enable-optional-tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--grpc-enable-tracing Enable gRPC tracing.
--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)
--grpc-use-effective-callerid If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal.
--grpc-use-effective-groups If set, and SSL is not used, will set the immediate caller's security groups from the effective caller id's groups.
--grpc-use-static-authentication-callerid If set, will set the immediate caller id to the username authenticated by the static auth plugin.
--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_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_crl string path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake
--grpc_enable_optional_tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--grpc_enable_tracing Enable gRPC tracing.
--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)
--grpc_use_effective_callerid If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal.
--health_check_interval duration Interval between health checks (default 20s)
--healthcheck_retry_delay duration health check retry delay (default 2ms)
--healthcheck_timeout duration the health check timeout period (default 1m0s)
--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-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 vtcombo
--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) the tablet type to use for this tablet.
--init_tags StringMap (init parameter) comma separated list of key:value pairs used to tag the tablet
--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
--json_topo vttest.TopoData vttest proto definition of the topology, encoded in json format. See vttest.proto for more information.
--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)
--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)
--keyspaces_to_watch strings Specifies which keyspaces this vtgate should have access to while routing queries or accessing the vschema.
--lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms)
--lock-timeout duration Maximum time to wait when attempting to acquire a lock from the topo server (default 45s)
--lock_heartbeat_time duration If there is lock function used. This will keep the lock connection active by using this heartbeat (default 5s)
--lock_tables_timeout duration How long to keep the table locked before timing out (default 1m0s)
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--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)
--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-stack-size int configure the maximum stack size in bytes (default 67108864)
@ -199,28 +199,32 @@ Flags:
--max_payload_size int The threshold for query payloads in bytes. A payload greater than this threshold will result in a failure to handle the query.
--message_stream_grace_period duration the amount of time to give for a vttablet to resume if it ends a message stream, usually because of a reparent. (default 30s)
--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_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_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-drain-onterm If set, the server waits for --onterm_timeout for already connected clients to complete their in flight work
--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-auth-server-impl string Which auth server implementation to use. Options: none, ldap, clientcert, static, vault. (default "static")
--mysql-port int mysql port (default 3306)
--mysql-server-drain-onterm If set, the server waits for --onterm-timeout for already connected clients to complete their in flight work
--mysql-server-keepalive-period duration TCP period between keep-alives
--mysql-server-multi-query-protocol If set, the server will use the new implementation of handling queries where-in multiple queries are sent together.
--mysql-server-pool-conn-read-buffers If set, the server will pool incoming connection read buffers
--mysql-server-port int If set, also listen for MySQL binary protocol connections on this port. (default -1)
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-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")
@ -229,12 +233,9 @@ Flags:
--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)
--mysql_allow_clear_text_without_tls If set, the server will allow the use of a clear text password over non-SSL connections.
--mysql_auth_server_impl string Which auth server implementation to use. Options: none, ldap, clientcert, static, vault. (default "static")
--mysql_default_workload string Default session workload (OLTP, OLAP, DBA) (default "OLTP")
--mysql_port int mysql port (default 3306)
--mysql_server_bind_address string Binds on this address when listening to MySQL binary protocol. Useful to restrict listening to 'localhost' only for instance.
--mysql_server_flush_delay duration Delay after which buffered response will be flushed to the client. (default 100ms)
--mysql_server_port int If set, also listen for MySQL binary protocol connections on this port. (default -1)
--mysql_server_query_timeout duration mysql query timeout
--mysql_server_read_timeout duration connection read timeout
--mysql_server_require_secure_transport Reject insecure connections but only if mysql_server_ssl_cert and mysql_server_ssl_key are provided
@ -245,7 +246,6 @@ Flags:
--mysql_server_ssl_key string Path to ssl key for mysql server plugin SSL
--mysql_server_ssl_server_ca string path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients
--mysql_server_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3.
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--mysql_server_write_timeout duration connection write timeout
--mysql_slow_connect_warn_threshold duration Warn if it takes more than the given threshold for a mysql connection to establish
--mysql_tcp_version string Select tcp, tcp4, or tcp6 to control the socket type. (default "tcp")
@ -253,11 +253,11 @@ Flags:
--mysqlctl_socket string socket file to use for remote mysqlctl actions (empty for local actions)
--no_scatter when set to true, the planner will fail instead of producing a plan that includes scatter queries
--normalize_queries Rewrite queries with bind vars. Turn this off if the app itself sends normalized queries with bind vars. (default true)
--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)
--pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--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)
--pid-file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--planner-version string Sets the default planner to use when the session has not changed it. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right
--pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled)
--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
@ -265,7 +265,7 @@ Flags:
--proxy_protocol Enable HAProxy PROXY protocol on MySQL listener socket
--proxy_tablets Setting this true will make vtctld proxy the tablet status instead of redirecting to them
--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)
--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-timeout int Sets the default query timeout (in ms). Can be overridden by session variable (query_timeout) or comment directive (QUERY_TIMEOUT_MS)
--querylog-buffer-size int Maximum number of buffered query logs before throttling log output (default 10)
@ -307,8 +307,8 @@ Flags:
--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)
--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-from-backup-allowed-engines strings (init restore parameter) if set, only backups taken with the specified engines are eligible to be restored
--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'
@ -321,65 +321,65 @@ Flags:
--schema-version-max-age-seconds int max age of schema version records to kept in memory by the vreplication historian
--schema_change_signal Enable the schema tracker; requires queryserver-config-schema-change-signal to be enabled on the underlying vttablets for this to work (default true)
--schema_dir string Schema base directory. Should contain one directory per keyspace, with a vschema.json file if necessary.
--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)
--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
--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)
--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)
--start_mysql Should vtcombo also start mysql
--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)
--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)
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--stream_buffer_size int the number of bytes sent from vtgate for each stream call. It's recommended to keep this value in sync with vttablet's query-server-config-stream-buffer-size. (default 32768)
--stream_health_buffer_size uint max streaming health entries to buffer per streaming health client (default 20)
--table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class
--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")
--tablet-dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
--tablet-filter-tags StringMap Specifies a comma-separated list of tablet tags (as key:value pairs) to filter the tablets to watch.
--tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
--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-refresh-interval duration Tablet refresh interval. (default 1m0s)
--tablet-refresh-known-tablets Whether to reload the tablet's address/port map from topo in case they change. (default true)
--tablet-types-to-wait strings Wait till connected for specified tablet types during Gateway initialization. Should be provided as a comma-separated set of tablet types.
--tablet-url-template string Format string describing debug tablet url formatting. See getTabletDebugURL() for how to customize this. (default "http://{{ "{{.GetTabletHostPort}}" }}")
--tablet_filters strings Specifies a comma-separated list of 'keyspace|shard_name or keyrange' values to filter the tablets to watch.
--tablet_health_keep_alive duration close streaming tablet health connection if there are no requests for this long (default 5m0s)
--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_refresh_interval duration Tablet refresh interval. (default 1m0s)
--tablet_refresh_known_tablets Whether to reload the tablet's address/port map from topo in case they change. (default true)
--tablet_types_to_wait strings Wait till connected for specified tablet types during Gateway initialization. Should be provided as a comma-separated set of tablet types.
--tablet_url_template string Format string describing debug tablet url formatting. See getTabletDebugURL() for how to customize this. (default "http://{{ "{{.GetTabletHostPort}}" }}")
--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
--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
--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)
@ -424,8 +424,8 @@ Flags:
--vschema-persistence-dir string If set, per-keyspace vschema will be persisted in this directory and reloaded into the in-memory topology server across restarts. Bookkeeping is performed using a simple watcher goroutine. This is useful when running vtcombo as an application development container (e.g. vttestserver) where you want to keep the same vschema even if developer's machine reboots. This works in tandem with vttestserver's --persistent_mode flag. Needless to say, this is neither a perfect nor a production solution for vschema persistence. Consider using the --external_topo_server flag if you require a more complete solution. This flag is ignored if --external_topo_server is set.
--vschema_ddl_authorized_users string List of users authorized to execute vschema ddl operations, or '%' to allow all users.
--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 VReplication. This will adjust the packet size during replication to improve performance. (default true)
--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)
--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)
--vtctld_sanitize_log_messages When true, vtctld sanitizes logging.
--vtgate-config-terse-errors prevent bind vars from escaping in returned errors
--vtgate_grpc_ca string the server ca to use to validate servers when connecting
@ -433,7 +433,7 @@ Flags:
--vtgate_grpc_crl string the server crl to use to validate server certificates when connecting
--vtgate_grpc_key string the key to use to connect
--vtgate_grpc_server_name string the server name to use to validate server certificate
--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 "/.*/")
--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
--warming-reads-concurrency int Number of concurrent warming reads allowed (default 500)
--warming-reads-percent int Percentage of reads on the primary to forward to replicas. Useful for keeping buffer pools warm
@ -443,10 +443,10 @@ Flags:
--warn_sharded_only If any features that are only available in unsharded mode are used, query execution warnings will be added to the session
--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_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.
--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-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.

30
go/flags/endtoend/vtctlclient.txt
View File

@ -9,31 +9,31 @@ Usage of vtctlclient:
--config-type string Config file type (omit to infer config type from file extension).
--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
--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-compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
--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_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_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
--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_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_prometheus Enable gRPC monitoring with Prometheus.
--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-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-prometheus Enable gRPC monitoring with Prometheus.
-h, --help display usage and exit
--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)
--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)
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--log_link string If non-empty, add symbolic links in this directory to the log files
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logbuflevel int Buffer log messages logged at this level or lower (-1 means don't buffer; 0 means buffer INFO only; ...). Has limited applicability on non-prod platforms.
--logtostderr log to standard error instead of files
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--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)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--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)
--server string server to use for connection
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--tracer string tracing service to use (default "noop")

230
go/flags/endtoend/vtctld.txt
View File

@ -3,7 +3,7 @@ It is usually the first Vitess component to be started after a valid global topo
For the last several releases, vtctld has been transitioning to a newer gRPC service for well-typed cluster management requests.
This is **required** to use programs such as vtadmin and vtctldclient, and The old API and service are deprecated and will be removed in a future release.
To enable this newer service, include "grpc-vtctld" in the --service_map argument.
To enable this newer service, include "grpc-vtctld" in the --service-map argument.
This is demonstrated in the example usage below.
Usage:
@ -11,35 +11,35 @@ Usage:
Examples:
vtctld \
--topo_implementation etcd2 \
--topo_global_server_address localhost:2379 \
--topo_global_root /vitess/ \
--service_map 'grpc-vtctl,grpc-vtctld' \
--backup_storage_implementation file \
--topo-implementation etcd2 \
--topo-global-server-address localhost:2379 \
--topo-global-root /vitess/ \
--service-map 'grpc-vtctl,grpc-vtctld' \
--backup-storage-implementation file \
--file_backup_storage_root $VTDATAROOT/backups \
--port 15000 \
--grpc_port 15999
--grpc-port 15999
Flags:
--action_timeout duration time to wait for an action before resorting to force (default 1m0s)
--alsologtostderr log to standard error as well as files
--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)
--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.
--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)
--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
--cell string cell to use
--ceph_backup_storage_config string Path to JSON config file for ceph backup storage. (default "ceph_backup_config.json")
@ -49,129 +49,129 @@ Flags:
--config-path strings Paths to search for config files in. (default [{{ .Workdir }}])
--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).
--consul_auth_static_file string JSON File to read the topos/tokens from.
--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
--disable_active_reparents if set, do not allow active reparents. Use this to protect a cluster using external reparents.
--emit_stats If set, emit stats to push-based monitoring and stats backends
--emit-stats If set, emit stats to push-based monitoring and stats backends
--file_backup_storage_root string Root directory for the file backup storage.
--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.
--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_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_enable_optional_tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--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)
--grpc-enable-optional-tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--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)
-h, --help help for vtctld
--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)
--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-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-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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logtostderr log to standard error instead of files
--max-stack-size int configure the maximum stack size in bytes (default 67108864)
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--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)
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-Vitess")
--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.
--pid-file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--port int port for the server
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--proxy_tablets Setting this true will make vtctld proxy the tablet status instead of redirecting to them
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--remote_operation_timeout duration time to wait for a remote operation (default 15s)
--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.
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--remote-operation-timeout duration time to wait for a remote operation (default 15s)
--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.
--schema_change_check_interval duration How often the schema change dir is checked for schema changes. This value must be positive; if zero or lower, the default of 1m is used. (default 1m0s)
--schema_change_controller string Schema change controller is responsible for finding schema changes and responding to schema change events.
--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.
--schema_change_replicas_timeout duration How long to wait for replicas to receive a schema change. (default 10s)
--schema_change_user string The user who schema changes are submitted on behalf of.
--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)
--service_map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--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)
--service-map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--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)
--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)
--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)
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class
--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-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-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-protocol string Protocol to use to make queryservice RPCs to vttablets. (default "grpc")
--tablet-refresh-interval duration Tablet refresh interval. (default 1m0s)
--tablet-refresh-known-tablets Whether to reload the tablet's address/port map from topo in case they change. (default true)
--tablet-url-template string Format string describing debug tablet url formatting. See getTabletDebugURL() for how to customize this. (default "http://{{ "{{.GetTabletHostPort}}" }}")
--tablet_health_keep_alive duration close streaming tablet health connection if there are no requests for this long (default 5m0s)
--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_protocol string Protocol to use to make queryservice RPCs to vttablets. (default "grpc")
--tablet_refresh_interval duration Tablet refresh interval. (default 1m0s)
--tablet_refresh_known_tablets Whether to reload the tablet's address/port map from topo in case they change. (default true)
--tablet_url_template string Format string describing debug tablet url formatting. See getTabletDebugURL() for how to customize this. (default "http://{{ "{{.GetTabletHostPort}}" }}")
--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
--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
--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)

44
go/flags/endtoend/vtctldclient.txt
View File

@ -121,36 +121,36 @@ Flags:
--action_timeout duration timeout to use for the command (default 1h0m0s)
--alsologtostderr log to standard error as well as files
--compact use compact format for otherwise verbose outputs
--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_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
--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_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_prometheus Enable gRPC monitoring with Prometheus.
--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-compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
--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-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-prometheus Enable gRPC monitoring with Prometheus.
-h, --help help for vtctldclient
--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)
--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)
--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
--log_link string If non-empty, add symbolic links in this directory to the log files
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logbuflevel int Buffer log messages logged at this level or lower (-1 means don't buffer; 0 means buffer INFO only; ...). Has limited applicability on non-prod platforms.
--logtostderr log to standard error instead of files
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--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)
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-Vitess")
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--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)
--server string server to use for the connection (required)
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--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_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-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-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")
--topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global")
--topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379])
--topo-implementation string the topology implementation to use (default "etcd2")

14
go/flags/endtoend/vtexplain.txt
View File

@ -50,26 +50,26 @@ Flags:
--default_tablet_type topodatapb.TabletType The default tablet type to set for queries, when one is not explicitly selected. (default PRIMARY)
--execution-mode string The execution mode to simulate -- must be set to multi, legacy-autocommit, or twopc (default "multi")
-h, --help help for vtexplain
--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)
--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)
--ks-shard-map string JSON map of keyspace name -> shard name -> ShardReference object. The inner map is the same as the output of FindAllShardsInKeyspace
--ks-shard-map-file string File containing json blob of keyspace name -> shard name -> ShardReference object
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logtostderr log to standard error instead of files
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-Vitess")
--normalize Whether to enable vtgate normalization
--output-mode string Output in human-friendly text or json (default "text")
--planner-version string Sets the default planner to use. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--replication-mode string The replication mode to simulate -- must be set to either ROW or STATEMENT (default "ROW")
--schema string The SQL table schema
--schema-file string Identifies the file that contains the SQL table schema
--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)
--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)
--shards int Number of shards per keyspace. Passing --ks-shard-map/--ks-shard-map-file causes this flag to be ignored. (default 2)
--sql string A list of semicolon-delimited SQL commands to analyze
--sql-file string Identifies the file that contains the SQL commands to analyze

184
go/flags/endtoend/vtgate.txt
View File

@ -2,7 +2,7 @@ VTGate is a stateless proxy responsible for accepting requests from applications
### Key Options
* `--srv_topo_cache_ttl`: There may be instances where you will need to increase the cached TTL from the default of 1 second to a higher number:
* `--srv-topo-cache-ttl`: There may be instances where you will need to increase the cached TTL from the default of 1 second to a higher number:
* You may want to increase this option if you see that your topo leader goes down and keeps your queries waiting for a few seconds.
Usage:
@ -10,19 +10,19 @@ Usage:
Examples:
vtgate \
--topo_implementation etcd2 \
--topo_global_server_address localhost:2379 \
--topo_global_root /vitess/global \
--topo-implementation etcd2 \
--topo-global-server-address localhost:2379 \
--topo-global-root /vitess/global \
--log_dir $VTDATAROOT/tmp \
--port 15001 \
--grpc_port 15991 \
--mysql_server_port 15306 \
--grpc-port 15991 \
--mysql-server-port 15306 \
--cell test \
--cells_to_watch test \
--tablet_types_to_wait PRIMARY,REPLICA \
--service_map 'grpc-vtgateservice' \
--pid_file $VTDATAROOT/tmp/vtgate.pid \
--mysql_auth_server_impl none
--tablet-types-to-wait PRIMARY,REPLICA \
--service-map 'grpc-vtgateservice' \
--pid-file $VTDATAROOT/tmp/vtgate.pid \
--mysql-auth-server-impl none
Flags:
--allow-kill-statement Allows the execution of kill statement
@ -46,7 +46,7 @@ Flags:
--config-path strings Paths to search for config files in. (default [{{ .Workdir }}])
--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).
--consul_auth_static_file string JSON File to read the topos/tokens from.
--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
--dbddl_plugin string controls how to handle CREATE/DROP DATABASE. use it if you are using your own database provisioning service (default "fail")
@ -54,7 +54,7 @@ Flags:
--default_tablet_type topodatapb.TabletType The default tablet type to set for queries, when one is not explicitly selected. (default PRIMARY)
--discovery_high_replication_lag_minimum_serving duration Threshold above which replication lag is considered too high when applying the min_number_serving_vttablets flag. (default 2h0m0s)
--discovery_low_replication_lag duration Threshold below which replication lag is considered low enough to be healthy. (default 30s)
--emit_stats If set, emit stats to push-based monitoring and stats backends
--emit-stats If set, emit stats to push-based monitoring and stats backends
--enable-balancer Enable the tablet balancer to evenly spread query load for a given tablet type
--enable-partial-keyspace-migration (Experimental) Follow shard routing rules: enable only while migrating a keyspace shard by shard. See documentation on Partial MoveTables for more. (default false)
--enable-views Enable views support in vtgate. (default true)
@ -67,66 +67,68 @@ Flags:
--foreign_key_mode string This is to provide how to handle foreign key constraint in create/alter table. Valid values are: allow, disallow (default "allow")
--gate_query_cache_memory int gate server query cache size in bytes, maximum amount of memory to be cached. vtgate analyzes every incoming query and generate a query plan, these plans are being cached in a lru cache. This config controls the capacity of the lru cache. (default 33554432)
--gateway_initial_tablet_timeout duration At startup, the tabletGateway will wait up to this duration to get at least one tablet per keyspace/shard/tablet type (default 30s)
--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
--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)
--grpc-use-effective-callerid If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal.
--grpc-use-effective-groups If set, and SSL is not used, will set the immediate caller's security groups from the effective caller id's groups.
--grpc-use-static-authentication-callerid If set, will set the immediate caller id to the username authenticated by the static auth plugin.
--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_enable_optional_tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--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)
--grpc_use_effective_callerid If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal.
--healthcheck_retry_delay duration health check retry delay (default 2ms)
--healthcheck_timeout duration the health check timeout period (default 1m0s)
-h, --help help for vtgate
--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)
--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)
--keyspaces_to_watch strings Specifies which keyspaces this vtgate should have access to while routing queries or accessing the vschema.
--lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms)
--legacy_replication_lag_algorithm Use the legacy algorithm when selecting vttablets for serving. (default true)
--lock-timeout duration Maximum time to wait when attempting to acquire a lock from the topo server (default 45s)
--lock_heartbeat_time duration If there is lock function used. This will keep the lock connection active by using this heartbeat (default 5s)
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--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)
--logtostderr log to standard error instead of files
--max-stack-size int configure the maximum stack size in bytes (default 67108864)
--max_memory_rows int Maximum number of rows that will be held in memory for intermediate results as well as the final result. (default 300000)
--max_payload_size int The threshold for query payloads in bytes. A payload greater than this threshold will result in a failure to handle the query.
--message_stream_grace_period duration the amount of time to give for a vttablet to resume if it ends a message stream, usually because of a reparent. (default 30s)
--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)
--mysql-server-drain-onterm If set, the server waits for --onterm_timeout for already connected clients to complete their in flight work
--mysql-auth-server-impl string Which auth server implementation to use. Options: none, ldap, clientcert, static, vault. (default "static")
--mysql-server-drain-onterm If set, the server waits for --onterm-timeout for already connected clients to complete their in flight work
--mysql-server-keepalive-period duration TCP period between keep-alives
--mysql-server-multi-query-protocol If set, the server will use the new implementation of handling queries where-in multiple queries are sent together.
--mysql-server-pool-conn-read-buffers If set, the server will pool incoming connection read buffers
--mysql-server-port int If set, also listen for MySQL binary protocol connections on this port. (default -1)
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-Vitess")
--mysql_allow_clear_text_without_tls If set, the server will allow the use of a clear text password over non-SSL connections.
--mysql_auth_server_impl string Which auth server implementation to use. Options: none, ldap, clientcert, static, vault. (default "static")
--mysql_auth_server_static_file string JSON File to read the users/passwords from.
--mysql_auth_server_static_string string JSON representation of the users/passwords config.
--mysql_auth_static_reload_interval duration Ticker to reload credentials
@ -146,7 +148,6 @@ Flags:
--mysql_ldap_auth_method string client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default "mysql_clear_password")
--mysql_server_bind_address string Binds on this address when listening to MySQL binary protocol. Useful to restrict listening to 'localhost' only for instance.
--mysql_server_flush_delay duration Delay after which buffered response will be flushed to the client. (default 100ms)
--mysql_server_port int If set, also listen for MySQL binary protocol connections on this port. (default -1)
--mysql_server_query_timeout duration mysql query timeout
--mysql_server_read_timeout duration connection read timeout
--mysql_server_require_secure_transport Reject insecure connections but only if mysql_server_ssl_cert and mysql_server_ssl_key are provided
@ -157,22 +158,21 @@ Flags:
--mysql_server_ssl_key string Path to ssl key for mysql server plugin SSL
--mysql_server_ssl_server_ca string path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients
--mysql_server_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3.
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--mysql_server_write_timeout duration connection write timeout
--mysql_slow_connect_warn_threshold duration Warn if it takes more than the given threshold for a mysql connection to establish
--mysql_tcp_version string Select tcp, tcp4, or tcp6 to control the socket type. (default "tcp")
--no_scatter when set to true, the planner will fail instead of producing a plan that includes scatter queries
--normalize_queries Rewrite queries with bind vars. Turn this off if the app itself sends normalized queries with bind vars. (default true)
--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)
--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.
--pid-file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--planner-version string Sets the default planner to use when the session has not changed it. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right
--port int port for the server
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--proxy_protocol Enable HAProxy PROXY protocol on MySQL listener socket
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--query-timeout int Sets the default query timeout (in ms). Can be overridden by session variable (query_timeout) or comment directive (QUERY_TIMEOUT_MS)
--querylog-buffer-size int Maximum number of buffered query logs before throttling log output (default 10)
--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
@ -181,56 +181,56 @@ Flags:
--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)
--redact-debug-ui-queries redact full queries and bind variables from debug UI
--remote_operation_timeout duration time to wait for a remote operation (default 15s)
--remote-operation-timeout duration time to wait for a remote operation (default 15s)
--retry-count int retry count (default 2)
--schema_change_signal Enable the schema tracker; requires queryserver-config-schema-change-signal to be enabled on the underlying vttablets for this to work (default true)
--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)
--service_map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--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)
--service-map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--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)
--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_buffer_size int the number of bytes sent from vtgate for each stream call. It's recommended to keep this value in sync with vttablet's query-server-config-stream-buffer-size. (default 32768)
--table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class
--tablet-filter-tags StringMap Specifies a comma-separated list of tablet tags (as key:value pairs) to filter the tablets to watch.
--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-protocol string Protocol to use to make queryservice RPCs to vttablets. (default "grpc")
--tablet-refresh-interval duration Tablet refresh interval. (default 1m0s)
--tablet-refresh-known-tablets Whether to reload the tablet's address/port map from topo in case they change. (default true)
--tablet-types-to-wait strings Wait till connected for specified tablet types during Gateway initialization. Should be provided as a comma-separated set of tablet types.
--tablet-url-template string Format string describing debug tablet url formatting. See getTabletDebugURL() for how to customize this. (default "http://{{ "{{.GetTabletHostPort}}" }}")
--tablet_filters strings Specifies a comma-separated list of 'keyspace|shard_name or keyrange' values to filter the tablets to watch.
--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_protocol string Protocol to use to make queryservice RPCs to vttablets. (default "grpc")
--tablet_refresh_interval duration Tablet refresh interval. (default 1m0s)
--tablet_refresh_known_tablets Whether to reload the tablet's address/port map from topo in case they change. (default true)
--tablet_types_to_wait strings Wait till connected for specified tablet types during Gateway initialization. Should be provided as a comma-separated set of tablet types.
--tablet_url_template string Format string describing debug tablet url formatting. See getTabletDebugURL() for how to customize this. (default "http://{{ "{{.GetTabletHostPort}}" }}")
--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
--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
--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)

78
go/flags/endtoend/vtgateclienttest.txt
View File

@ -14,55 +14,55 @@ Flags:
--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).
--default_tablet_type topodatapb.TabletType The default tablet type to set for queries, when one is not explicitly selected. (default PRIMARY)
--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_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_enable_optional_tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--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)
--grpc-enable-optional-tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--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)
-h, --help help for vtgateclienttest
--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)
--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)
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logtostderr log to standard error instead of files
--max-stack-size int configure the maximum stack size in bytes (default 67108864)
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--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)
--pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-Vitess")
--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)
--pid-file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--port int port for the server
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--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)
--service_map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--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)
--service-map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class
--v Level log level for V logs

110
go/flags/endtoend/vtorc.txt
View File

@ -5,9 +5,9 @@ Usage:
Examples:
vtorc \
--topo_implementation etcd2 \
--topo_global_server_address localhost:2379 \
--topo_global_root /vitess/global \
--topo-implementation etcd2 \
--topo-global-server-address localhost:2379 \
--topo-global-root /vitess/global \
--log_dir $VTDATAROOT/tmp \
--port 15000 \
--instance-poll-time "1s" \
@ -33,82 +33,82 @@ Flags:
--config-path strings Paths to search for config files in. (default [{{ .Workdir }}])
--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).
--consul_auth_static_file string JSON File to read the topos/tokens from.
--consul-auth-static-file string JSON File to read the topos/tokens from.
--discovery-workers int Number of workers used for tablet discovery (default 300)
--emit_stats If set, emit stats to push-based monitoring and stats backends
--emit-stats If set, emit stats to push-based monitoring and stats backends
--enable-primary-disk-stalled-recovery Whether VTOrc should detect a stalled disk on the primary and failover
--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-compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
--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_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_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
--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_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_prometheus Enable gRPC monitoring with Prometheus.
--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-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-prometheus Enable gRPC monitoring with Prometheus.
-h, --help help for vtorc
--instance-poll-time duration Timer duration on which VTOrc refreshes MySQL information (default 5s)
--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)
--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-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-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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logtostderr log to standard error instead of files
--max-stack-size int configure the maximum stack size in bytes (default 67108864)
--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)
--pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--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)
--pid-file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--port int port for the server
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--prevent-cross-cell-failover Prevent VTOrc from promoting a primary in a different cell than the current primary in case of a failover
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--reasonable-replication-lag duration Maximum replication lag on replicas which is deemed to be acceptable (default 10s)
--recovery-poll-duration duration Timer duration on which VTOrc polls its database to run a recovery (default 1s)
--remote_operation_timeout duration time to wait for a remote operation (default 15s)
--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)
--remote-operation-timeout duration time to wait for a remote operation (default 15s)
--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)
--shutdown_wait_time duration Maximum time to wait for VTOrc to release all the locks that it is holding before shutting down on SIGTERM (default 30s)
--snapshot-topology-interval duration Timer duration on which VTOrc takes a snapshot of the current MySQL information it has in the database. Should be in multiple of hours
--sqlite-data-file string SQLite Datafile to use as VTOrc's database (default "file::memory:?mode=memory&cache=shared")
--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)
--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)
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class
--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-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")
--tolerable-replication-lag duration Amount of replication lag that is considered acceptable for a tablet to be eligible for promotion when Vitess makes the choice of a new primary in PRS
--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-information-refresh-duration duration Timer duration on which VTOrc refreshes the keyspace and vttablet records from the topology server (default 15s)
--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
--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
--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

382
go/flags/endtoend/vttablet.txt
View File

@ -18,8 +18,8 @@ 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.
* `--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]
@ -27,16 +27,16 @@ Usage:
Examples:
vttablet \
--topo_implementation etcd2 \
--topo_global_server_address localhost:2379 \
--topo_global_root /vitess/ \
--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 \
--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'
--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.
@ -44,17 +44,17 @@ 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)
--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
@ -66,8 +66,8 @@ Flags:
--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)
--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")
@ -81,9 +81,21 @@ Flags:
--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.
--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
--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
@ -95,49 +107,37 @@ Flags:
--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_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_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.
--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
--emit-stats If set, emit stats to push-based monitoring and stats backends
--enable-consolidator Synonym to -enable_consolidator (default true)
--enable-consolidator-replicas Synonym to -enable_consolidator_replicas
--enable-per-workload-table-metrics If true, query counts and query error metrics include a label that identifies the workload
@ -160,86 +160,87 @@ Flags:
--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.
--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_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_enable_optional_tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--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)
--grpc-enable-optional-tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--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-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) the tablet type to use for this tablet.
--init_tags StringMap (init parameter) comma separated list of key:value pairs used to tag the tablet
--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)
--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-timeout duration Maximum time to wait when attempting to acquire a lock from the topo server (default 45s)
--lock_tables_timeout duration How long to keep the table locked before timing out (default 1m0s)
--log-err-stacks log stack traces for errors
--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
--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)
--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-stack-size int configure the maximum stack size in bytes (default 67108864)
--max_concurrent_online_ddl int Maximum number of online DDL changes that may run concurrently (default 256)
--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_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_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
--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.0.40-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")
@ -247,19 +248,18 @@ Flags:
--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)
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--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)
--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)
--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)
--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")
--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")
@ -299,8 +299,8 @@ Flags:
--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)
--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-from-backup-allowed-engines strings (init restore parameter) if set, only backups taken with the specified engines are eligible to be restored
--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'
@ -308,36 +308,36 @@ Flags:
--restore_from_backup (init restore parameter) will check BackupStorage for a recent backup at startup and start there
--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'
--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.
--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)
--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
--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)
--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)
@ -346,43 +346,43 @@ Flags:
--table-acl-config-reload-interval duration Ticker to reload ACLs. Duration flag, format e.g.: 30s. Default: do not reload
--table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class
--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")
--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")
--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_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
--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")
@ -424,16 +424,16 @@ Flags:
--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 VReplication. This will adjust the packet size during replication to improve performance. (default true)
--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)
--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 "/.*/")
--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_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.
--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-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.

164
go/flags/endtoend/vttestserver.txt
View File

@ -7,15 +7,15 @@ 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)
--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_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)
--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-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)
--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)
--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
--cells strings Comma separated list of cells (default [test])
--charset string MySQL charset (default "utf8mb4")
@ -27,7 +27,7 @@ Flags:
--config-path strings Paths to search for config files in. (default [{{ .Workdir }}])
--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).
--consul_auth_static_file string JSON File to read the topos/tokens from.
--consul-auth-static-file string JSON File to read the topos/tokens from.
--data_dir string Directory where the data files will be placed, defaults to a random directory under /vt/vtdataroot
--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)
@ -43,51 +43,52 @@ Flags:
--external_topo_implementation string the topology implementation to use for vtcombo process
--extra_my_cnf string extra files to add to the config, separated by ':'
--foreign_key_mode string This is to provide how to handle foreign key constraint in create/alter table. Valid values are: allow, disallow (default "allow")
--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_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_enable_optional_tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--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)
--grpc-enable-optional-tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port
--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)
-h, --help help for vttestserver
--initialize-with-random-data If this flag is each table-shard will be initialized with random data. See also the 'rng_seed' and 'min_shard_size' and 'max_shard_size' flags.
--initialize-with-vt-dba-tcp If this flag is enabled, MySQL will be initialized with an additional user named vt_dba_tcp, who will have access via TCP/IP connection.
--initialize_with_random_data If this flag is each table-shard will be initialized with random data. See also the 'rng_seed' and 'min_shard_size' and 'max_shard_size' flags.
--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)
--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)
--keyspaces strings Comma separated list of keyspaces (default [test_keyspace])
--lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms)
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--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-stack-size int configure the maximum stack size in bytes (default 67108864)
--max_table_shard_size int The maximum number of initial rows in a table shard. Ignored if--initialize_with_random_data is false. The actual number is chosen randomly (default 10000)
--min_table_shard_size int The minimum number of initial rows in a table shard. Ignored if--initialize_with_random_data is false. The actual number is chosen randomly. (default 1000)
--max_table_shard_size int The maximum number of initial rows in a table shard. Ignored if--initialize-with-random-data is false. The actual number is chosen randomly (default 10000)
--min_table_shard_size int The minimum number of initial rows in a table shard. Ignored if--initialize-with-random-data is false. The actual number is chosen randomly. (default 1000)
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-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")
@ -96,57 +97,56 @@ Flags:
--mysql-shell-speedup-restore speed up restore by disabling redo logging and double write buffer during the restore process
--mysql_bind_host string which host to bind vtgate mysql listener to (default "localhost")
--mysql_only If this flag is set only mysql is initialized. The rest of the vitess components are not started. Also, the output specifies the mysql unix socket instead of the vtgate port.
--mysql_server_version string MySQL server version to advertise. (default "8.0.40-Vitess")
--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)
--no_scatter when set to true, the planner will fail instead of producing a plan that includes scatter queries
--null_probability float The probability to initialize a field with 'NULL' if --initialize_with_random_data is true. Only applies to fields that can contain NULL values. (default 0.1)
--null_probability float The probability to initialize a field with 'NULL' if --initialize-with-random-data is true. Only applies to fields that can contain NULL values. (default 0.1)
--num_shards strings Comma separated shard count (one per keyspace) (default [2])
--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)
--persistent_mode If this flag is set, the MySQL data directory is not cleaned up when LocalCluster.TearDown() is called. This is useful for running vttestserver as a database container in local developer environments. Note that db migration files (--schema_dir option) and seeding of random data (--initialize_with_random_data option) will only run during cluster startup if the data directory does not already exist. Changes to VSchema are persisted across cluster restarts using a simple watcher if the --data_dir argument is specified.
--pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--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)
--persistent_mode If this flag is set, the MySQL data directory is not cleaned up when LocalCluster.TearDown() is called. This is useful for running vttestserver as a database container in local developer environments. Note that db migration files (--schema_dir option) and seeding of random data (--initialize-with-random-data option) will only run during cluster startup if the data directory does not already exist. Changes to VSchema are persisted across cluster restarts using a simple watcher if the --data_dir argument is specified.
--pid-file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--planner-version string Sets the default planner to use when the session has not changed it. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right
--pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled)
--pool-hostname-resolve-interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled)
--port int Port to use for vtcombo. If this is 0, a random port will be chosen.
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--proto_topo string Define the fake cluster topology as a compact text format encoded vttest proto. See vttest.proto for more information.
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--queryserver-config-transaction-timeout duration query server transaction timeout, a transaction will be killed if it takes longer than this value (default 30s)
--rdonly_count int Rdonly tablets per shard (default 1)
--replica_count int Replica tablets per shard (includes primary) (default 2)
--replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s)
--rng_seed int The random number generator seed to use when initializing with random data (see also --initialize_with_random_data). Multiple runs with the same seed will result with the same initial data. (default 123)
--replication-connect-retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s)
--rng_seed int The random number generator seed to use when initializing with random data (see also --initialize-with-random-data). Multiple runs with the same seed will result with the same initial data. (default 123)
--schema_dir string Directory for initial schema files. Within this dir, there should be a subdir for each keyspace. Within each keyspace dir, each file is executed as SQL after the database is created on each shard. If the directory contains a vschema.json file, it will be used as the vschema for the V3 API.
--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)
--service_map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--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)
--service-map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--snapshot_file string A MySQL DB snapshot file
--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)
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class
--tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
--tablet_hostname string The hostname to use for the tablet otherwise it will be derived from OS' hostname (default "localhost")
--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_refresh_interval duration Interval at which vtgate refreshes tablet information from topology server. (default 10s)
--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_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
--tablet-dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
--tablet-hostname string The hostname to use for the tablet otherwise it will be derived from OS' hostname (default "localhost")
--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-refresh-interval duration Interval at which vtgate refreshes tablet information from topology server. (default 10s)
--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-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
--transaction_mode string Transaction mode MULTI (default), SINGLE or TWOPC (default "MULTI")
--v Level log level for V logs
-v, --version print binary version
@ -165,10 +165,10 @@ Flags:
--vtgate_grpc_key string the key to use to connect
--vtgate_grpc_server_name string the server name to use to validate server certificate
--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_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.
--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-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.

10
go/flags/endtoend/zk.txt
View File

@ -31,11 +31,11 @@ Available Commands:
Flags:
-h, --help help for zk
--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)
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--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)
--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)
--log-rotate-max-size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--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)
--server string server(s) to connect to
Use "zk [command] --help" for more information about a command.

10
go/flags/endtoend/zkctl.txt
View File

@ -20,16 +20,16 @@ Flags:
--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).
-h, --help help for zkctl
--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)
--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)
--log-err-stacks log stack traces for errors
--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
--log_err_stacks log stack traces for errors
--log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
--logtostderr log to standard error instead of files
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--purge_logs_interval duration how often try to remove old logs (default 1h0m0s)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1)
--v Level log level for V logs
-v, --version print binary version

6
go/mysql/conn_params.go
View File

@ -38,7 +38,7 @@ type ConnParams struct {
// The following SSL flags control the SSL behavior.
//
// Not setting this value implies preferred mode unless
// the CapabilityClientSSL bit is set in db_flags. In the
// the CapabilityClientSSL bit is set in db-flags. In the
// flag is set, it ends up equivalent to verify_identity mode.
SslMode vttls.SslMode
SslCa string
@ -93,7 +93,7 @@ func (cp *ConnParams) EnableClientFoundRows() {
// SslRequired returns whether the connection parameters
// define that SSL is a requirement. If SslMode is set, it uses
// that to determine this, if it's not set it falls back to
// the legacy db_flags behavior.
// the legacy db-flags behavior.
func (cp *ConnParams) SslRequired() bool {
mode := cp.EffectiveSslMode()
return mode != vttls.Disabled && mode != vttls.Preferred
@ -101,7 +101,7 @@ func (cp *ConnParams) SslRequired() bool {
// EffectiveSslMode computes the effective SslMode. If SslMode
// is explicitly set, it uses that to determine this, if it's
// not set it falls back to the legacy db_flags behavior.
// not set it falls back to the legacy db-flags behavior.
func (cp *ConnParams) EffectiveSslMode() vttls.SslMode {
if cp.SslMode == "" {
if (cp.Flags & CapabilityClientSSL) > 0 {

6
go/pools/smartconnpool/pool.go
View File

@ -401,7 +401,7 @@ func (pool *ConnPool[C]) put(conn *Pooled[C]) {
if conn == nil {
var err error
// Using context.Background() is fine since MySQL connection already enforces
// a connect timeout via the `db_connect_timeout_ms` config param.
// a connect timeout via the `db-connect-timeout-ms` config param.
conn, err = pool.connNew(context.Background())
if err != nil {
pool.closedConn()
@ -415,7 +415,7 @@ func (pool *ConnPool[C]) put(conn *Pooled[C]) {
pool.Metrics.maxLifetimeClosed.Add(1)
conn.Close()
// Using context.Background() is fine since MySQL connection already enforces
// a connect timeout via the `db_connect_timeout_ms` config param.
// a connect timeout via the `db-connect-timeout-ms` config param.
if err := pool.connReopen(context.Background(), conn, conn.timeUsed.get()); err != nil {
pool.closedConn()
return
@ -775,7 +775,7 @@ func (pool *ConnPool[C]) closeIdleResources(now time.Time) {
pool.Metrics.idleClosed.Add(1)
conn.Close()
// Using context.Background() is fine since MySQL connection already enforces
// a connect timeout via the `db_connect_timeout_ms` config param.
// a connect timeout via the `db-connect-timeout-ms` config param.
if err := pool.connReopen(context.Background(), conn, mono); err != nil {
pool.closedConn()
}

13
go/stats/export.go
View File

@ -40,6 +40,7 @@ import (
"github.com/spf13/pflag"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)
var (
@ -55,12 +56,12 @@ var (
var CommonTags []string
func RegisterFlags(fs *pflag.FlagSet) {
fs.BoolVar(&emitStats, "emit_stats", emitStats, "If set, emit stats to push-based monitoring and stats backends")
fs.DurationVar(&statsEmitPeriod, "stats_emit_period", statsEmitPeriod, "Interval between emitting stats to all registered backends")
fs.StringVar(&statsBackend, "stats_backend", statsBackend, "The name of the registered push-based monitoring/stats backend to use")
fs.StringVar(&combineDimensions, "stats_combine_dimensions", combineDimensions, `List of dimensions to be combined into a single "all" value in exported stats vars`)
fs.StringVar(&dropVariables, "stats_drop_variables", dropVariables, `Variables to be dropped from the list of exported variables.`)
fs.StringSliceVar(&CommonTags, "stats_common_tags", CommonTags, `Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2`)
utils.SetFlagBoolVar(fs, &emitStats, "emit-stats", emitStats, "If set, emit stats to push-based monitoring and stats backends")
utils.SetFlagDurationVar(fs, &statsEmitPeriod, "stats-emit-period", statsEmitPeriod, "Interval between emitting stats to all registered backends")
utils.SetFlagStringVar(fs, &statsBackend, "stats-backend", statsBackend, "The name of the registered push-based monitoring/stats backend to use")
utils.SetFlagStringVar(fs, &combineDimensions, "stats-combine-dimensions", combineDimensions, `List of dimensions to be combined into a single "all" value in exported stats vars`)
utils.SetFlagStringVar(fs, &dropVariables, "stats-drop-variables", dropVariables, `Variables to be dropped from the list of exported variables.`)
utils.SetFlagStringSliceVar(fs, &CommonTags, "stats-common-tags", CommonTags, `Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2`)
}
// StatsAllStr is the consolidated name if a dimension gets combined.

5
go/test/endtoend/backup/vtbackup/backup_only_test.go
View File

@ -36,6 +36,7 @@ import (
"vitess.io/vitess/go/test/endtoend/cluster"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/mysqlctl"
"vitess.io/vitess/go/vt/utils"
)
var (
@ -239,10 +240,10 @@ func startVtBackup(t *testing.T, initialBackup bool, restartBeforeBackup, disabl
extraArgs := []string{
"--allow_first_backup",
"--db-credentials-file", dbCredentialFile,
"--mysql_socket", mysqlSocket.Name(),
utils.GetFlagVariantForTests("--mysql-socket"), mysqlSocket.Name(),
// Use opentsdb for stats.
"--stats_backend", "opentsdb",
utils.GetFlagVariantForTests("--stats-backend"), "opentsdb",
// Write stats to file for reading afterwards.
"--opentsdb_uri", fmt.Sprintf("file://%s", statsPath),
}

25
go/test/endtoend/backup/vtctlbackup/backup_utils.go
View File

@ -46,6 +46,7 @@ import (
"vitess.io/vitess/go/vt/proto/topodata"
"vitess.io/vitess/go/vt/proto/vtrpc"
"vitess.io/vitess/go/vt/sqlparser"
vtutils "vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vterrors"
)
@ -143,16 +144,16 @@ func LaunchCluster(setupType int, streamMode string, stripes int, cDetails *Comp
switch setupType {
case XtraBackup:
xtrabackupArgs := []string{
"--backup_engine_implementation", "xtrabackup",
fmt.Sprintf("--xtrabackup_stream_mode=%s", streamMode),
"--xtrabackup_user=vt_dba",
fmt.Sprintf("--xtrabackup_stripes=%d", stripes),
"--xtrabackup_backup_flags", fmt.Sprintf("--password=%s", dbPassword),
vtutils.GetFlagVariantForTests("--backup-engine-implementation"), "xtrabackup",
fmt.Sprintf("%s=%s", vtutils.GetFlagVariantForTests("--xtrabackup-stream-mode"), streamMode),
fmt.Sprintf("%s=vt_dba", vtutils.GetFlagVariantForTests("--xtrabackup-user")),
fmt.Sprintf("%s=%d", vtutils.GetFlagVariantForTests("--xtrabackup-stripes"), stripes),
vtutils.GetFlagVariantForTests("--xtrabackup-backup-flags"), fmt.Sprintf("--password=%s", dbPassword),
}
// if streamMode is xbstream, add some additional args to test other xtrabackup flags
if streamMode == "xbstream" {
xtrabackupArgs = append(xtrabackupArgs, "--xtrabackup_prepare_flags", "--use-memory=100M")
xtrabackupArgs = append(xtrabackupArgs, vtutils.GetFlagVariantForTests("--xtrabackup-prepare-flags"), "--use-memory=100M")
}
commonTabletArg = append(commonTabletArg, xtrabackupArgs...)
@ -164,7 +165,7 @@ func LaunchCluster(setupType int, streamMode string, stripes int, cDetails *Comp
}
mysqlShellArgs := []string{
"--backup_engine_implementation", "mysqlshell",
vtutils.GetFlagVariantForTests("--backup-engine-implementation"), "mysqlshell",
"--mysql-shell-backup-location", mysqlShellBackupLocation,
}
commonTabletArg = append(commonTabletArg, mysqlShellArgs...)
@ -344,15 +345,15 @@ func TestBackup(t *testing.T, setupType int, streamMode string, stripes int, cDe
switch streamMode {
case "xbstream":
if vers.Major < 8 {
t.Logf("Skipping xtrabackup tests with --xtrabackup_stream_mode=xbstream as those are only tested on XtraBackup/MySQL 8.0+")
t.Logf("Skipping xtrabackup tests with --xtrabackup-stream-mode=xbstream as those are only tested on XtraBackup/MySQL 8.0+")
return nil
}
case "", "tar": // streaming method of tar is the default for the vttablet --xtrabackup_stream_mode flag
case "", "tar": // streaming method of tar is the default for the vttablet --xtrabackup-stream-mode flag
// XtraBackup 8.0 must be used with MySQL 8.0 and it no longer supports tar as a stream method:
// https://docs.percona.com/percona-xtrabackup/2.4/innobackupex/streaming_backups_innobackupex.html
// https://docs.percona.com/percona-xtrabackup/8.0/xtrabackup_bin/backup.streaming.html
if vers.Major > 5 {
t.Logf("Skipping xtrabackup tests with --xtrabackup_stream_mode=tar as tar is no longer a streaming option in XtraBackup 8.0")
t.Logf("Skipping xtrabackup tests with --xtrabackup-stream-mode=tar as tar is no longer a streaming option in XtraBackup 8.0")
return nil
}
default:
@ -988,10 +989,10 @@ func restoreWaitForBackup(t *testing.T, tabletType string, cDetails *Compression
replicaTabletArgs = updateCompressorArgs(replicaTabletArgs, cDetails)
}
if fakeImpl {
replicaTabletArgs = append(replicaTabletArgs, "--backup_engine_implementation", "fake_implementation")
replicaTabletArgs = append(replicaTabletArgs, vtutils.GetFlagVariantForTests("--backup-engine-implementation"), "fake_implementation")
}
replicaTabletArgs = append(replicaTabletArgs, "--wait_for_backup_interval", "1s")
replicaTabletArgs = append(replicaTabletArgs, "--init_tablet_type", tabletType)
replicaTabletArgs = append(replicaTabletArgs, vtutils.GetFlagVariantForTests("--init-tablet-type"), tabletType)
replica2.VttabletProcess.ExtraArgs = replicaTabletArgs
replica2.VttabletProcess.ServingStatus = ""
err := replica2.VttabletProcess.Setup()

3
go/test/endtoend/cluster/mysqlctl_process.go
View File

@ -54,6 +54,7 @@ type MysqlctlProcess struct {
// InitDb executes mysqlctl command to add cell info
func (mysqlctl *MysqlctlProcess) InitDb() (err error) {
args := []string{"--log_dir", mysqlctl.LogDirectory,
//TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
"--tablet_uid", fmt.Sprintf("%d", mysqlctl.TabletUID),
"--mysql_port", fmt.Sprintf("%d", mysqlctl.MySQLPort),
"init",
@ -98,6 +99,7 @@ func (mysqlctl *MysqlctlProcess) StartProcess() (*exec.Cmd, error) {
func (mysqlctl *MysqlctlProcess) startProcess(init bool) (*exec.Cmd, error) {
tmpProcess := exec.Command(
mysqlctl.Binary,
//TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
"--log_dir", mysqlctl.LogDirectory,
"--tablet_uid", fmt.Sprintf("%d", mysqlctl.TabletUID),
"--mysql_port", fmt.Sprintf("%d", mysqlctl.MySQLPort),
@ -227,6 +229,7 @@ func (mysqlctl *MysqlctlProcess) Stop() (err error) {
func (mysqlctl *MysqlctlProcess) StopProcess() (*exec.Cmd, error) {
tmpProcess := exec.Command(
mysqlctl.Binary,
//TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
"--log_dir", mysqlctl.LogDirectory,
"--tablet_uid", fmt.Sprintf("%d", mysqlctl.TabletUID),
)

3
go/test/endtoend/cluster/mysqlctld_process.go
View File

@ -51,6 +51,7 @@ type MysqlctldProcess struct {
// InitDb executes mysqlctld command to add cell info
func (mysqlctld *MysqlctldProcess) InitDb() (err error) {
args := []string{
//TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
"--log_dir", mysqlctld.LogDirectory,
"--tablet_uid", fmt.Sprintf("%d", mysqlctld.TabletUID),
"--mysql_port", fmt.Sprintf("%d", mysqlctld.MySQLPort),
@ -73,6 +74,7 @@ func (mysqlctld *MysqlctldProcess) Start() error {
}
_ = createDirectory(mysqlctld.LogDirectory, 0700)
args := []string{
//TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
"--log_dir", mysqlctld.LogDirectory,
"--tablet_uid", fmt.Sprintf("%d", mysqlctld.TabletUID),
"--mysql_port", fmt.Sprintf("%d", mysqlctld.MySQLPort),
@ -160,6 +162,7 @@ func (mysqlctld *MysqlctldProcess) Stop() error {
mysqlctld.exitSignalReceived = true
tmpProcess := exec.Command(
"mysqlctl",
//TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
"--tablet_uid", fmt.Sprintf("%d", mysqlctld.TabletUID),
)
tmpProcess.Args = append(tmpProcess.Args, mysqlctld.ExtraArgs...)

40
go/test/endtoend/cluster/vtbackup_process.go
View File

@ -26,6 +26,7 @@ import (
"time"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)
// VtbackupProcess is a generic handle for a running Vtbackup.
@ -55,23 +56,36 @@ type VtbackupProcess struct {
// Setup starts vtbackup process with required arguements
func (vtbackup *VtbackupProcess) Setup() (err error) {
vtbackup.proc = exec.Command(
vtbackup.Binary,
"--topo_implementation", vtbackup.TopoImplementation,
"--topo_global_server_address", vtbackup.TopoGlobalAddress,
"--topo_global_root", vtbackup.TopoGlobalRoot,
"--log_dir", vtbackup.LogDir,
flags := map[string]string{
"--topo-implementation": vtbackup.TopoImplementation,
"--topo-global-server-address": vtbackup.TopoGlobalAddress,
"--topo-global-root": vtbackup.TopoGlobalRoot,
"--log_dir": vtbackup.LogDir,
//initDBfile is required to run vtbackup
"--mysql_port", fmt.Sprintf("%d", vtbackup.MysqlPort),
"--init_db_sql_file", vtbackup.initDBfile,
"--init_keyspace", vtbackup.Keyspace,
"--init_shard", vtbackup.Shard,
"--mysql-port": fmt.Sprintf("%d", vtbackup.MysqlPort),
"--init_db_sql_file": vtbackup.initDBfile,
"--init-keyspace": vtbackup.Keyspace,
"--init-shard": vtbackup.Shard,
//Backup Arguments are not optional
"--backup_storage_implementation", vtbackup.BackupStorageImplementation,
"--file_backup_storage_root", vtbackup.FileBackupStorageRoot,
)
"--backup-storage-implementation": vtbackup.BackupStorageImplementation,
"--file_backup_storage_root": vtbackup.FileBackupStorageRoot,
}
utils.SetFlagVariantsForTests(flags, "--topo-implementation", vtbackup.TopoImplementation)
utils.SetFlagVariantsForTests(flags, "--topo-global-server-address", vtbackup.TopoGlobalAddress)
utils.SetFlagVariantsForTests(flags, "--topo-global-root", vtbackup.TopoGlobalRoot)
utils.SetFlagVariantsForTests(flags, "--mysql-port", fmt.Sprintf("%d", vtbackup.MysqlPort))
utils.SetFlagVariantsForTests(flags, "--init-keyspace", vtbackup.Keyspace)
utils.SetFlagVariantsForTests(flags, "--init-shard", vtbackup.Shard)
utils.SetFlagVariantsForTests(flags, "--backup-storage-implementation", vtbackup.BackupStorageImplementation)
vtbackup.proc = exec.Command(vtbackup.Binary)
for k, v := range flags {
vtbackup.proc.Args = append(vtbackup.proc.Args, k, v)
}
if vtbackup.initialBackup {
vtbackup.proc.Args = append(vtbackup.proc.Args, "--initial_backup")

1
go/test/endtoend/cluster/vtctld_process.go
View File

@ -53,6 +53,7 @@ func (vtctld *VtctldProcess) Setup(cell string, extraArgs ...string) (err error)
_ = createDirectory(path.Join(vtctld.Directory, "backups"), 0700)
vtctld.proc = exec.Command(
vtctld.Binary,
//TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
"--topo_implementation", vtctld.TopoImplementation,
"--topo_global_server_address", vtctld.TopoGlobalAddress,
"--topo_global_root", vtctld.TopoGlobalRoot,

5
go/test/endtoend/cluster/vtgate_process.go
View File

@ -33,6 +33,7 @@ import (
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/mysqlctl"
"vitess.io/vitess/go/vt/vtgate/planbuilder"
"vitess.io/vitess/go/vt/vtgate/planbuilder/plancontext"
)
@ -148,6 +149,7 @@ const defaultVtGatePlannerVersion = planbuilder.Gen4
// Setup starts Vtgate process with required arguements
func (vtgate *VtgateProcess) Setup() (err error) {
args := []string{
//TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
"--topo_implementation", vtgate.TopoImplementation,
"--topo_global_server_address", vtgate.TopoGlobalAddress,
"--topo_global_root", vtgate.TopoGlobalRoot,
@ -166,11 +168,13 @@ func (vtgate *VtgateProcess) Setup() (err error) {
"--bind-address", "127.0.0.1",
"--grpc_bind_address", "127.0.0.1",
}
// If no explicit mysql_server_version has been specified then we autodetect
// the MySQL version that will be used for the test and base the vtgate's
// mysql server version on that.
msvflag := false
for _, f := range vtgate.ExtraArgs {
// TODO: Replace flag with dashed version in v25
if strings.Contains(f, "mysql_server_version") {
msvflag = true
break
@ -199,6 +203,7 @@ func (vtgate *VtgateProcess) Setup() (err error) {
return err
}
mysqlvers := fmt.Sprintf("%d.%d.%d-vitess", vers.Major, vers.Minor, vers.Patch)
// TODO: Replace flag with dashed version in v25
args = append(args, "--mysql_server_version", mysqlvers)
}
if vtgate.PlannerVersion > 0 {

30
go/test/endtoend/cluster/vtorc_process.go
View File

@ -31,6 +31,7 @@ import (
"time"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)
// VTOrcProcess is a test struct for running
@ -112,18 +113,27 @@ func (orc *VTOrcProcess) Setup() (err error) {
}
/* minimal command line arguments:
$ vtorc --topo_implementation etcd2 --topo_global_server_address localhost:2379 --topo_global_root /vitess/global
$ vtorc --topo-implementation etcd2 --topo-global-server-address localhost:2379 --topo-global-root /vitess/global
--config config/vtorc/default.json --alsologtostderr
*/
orc.proc = exec.Command(
orc.Binary,
"--topo_implementation", orc.TopoImplementation,
"--topo_global_server_address", orc.TopoGlobalAddress,
"--topo_global_root", orc.TopoGlobalRoot,
"--config-file", orc.ConfigPath,
"--port", fmt.Sprintf("%d", orc.Port),
"--bind-address", "127.0.0.1",
)
flags := map[string]string{
"--topo-implementation": orc.TopoImplementation,
"--topo-global-server-address": orc.TopoGlobalAddress,
"--topo-global-root": orc.TopoGlobalRoot,
"--config-file": orc.ConfigPath,
"--port": fmt.Sprintf("%d", orc.Port),
"--bind-address": "127.0.0.1",
}
utils.SetFlagVariantsForTests(flags, "--topo-implementation", orc.TopoImplementation)
utils.SetFlagVariantsForTests(flags, "--topo-global-server-address", orc.TopoGlobalAddress)
utils.SetFlagVariantsForTests(flags, "--topo-global-root", orc.TopoGlobalRoot)
orc.proc = exec.Command(orc.Binary)
for flag, value := range flags {
orc.proc.Args = append(orc.proc.Args, flag, value)
}
if !orc.NoOverride {
orc.proc.Args = append(orc.proc.Args,
// This parameter is overriden from the config file. This verifies that we indeed use the flag value over the config file.

2
go/test/endtoend/cluster/vttablet_process.go
View File

@ -94,6 +94,7 @@ type VttabletProcess struct {
func (vttablet *VttabletProcess) Setup() (err error) {
vttablet.proc = exec.Command(
vttablet.Binary,
//TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
"--topo_implementation", vttablet.TopoImplementation,
"--topo_global_server_address", vttablet.TopoGlobalAddress,
"--topo_global_root", vttablet.TopoGlobalRoot,
@ -126,6 +127,7 @@ func (vttablet *VttabletProcess) Setup() (err error) {
if vttablet.SupportsBackup {
vttablet.proc.Args = append(vttablet.proc.Args, "--restore_from_backup")
}
//TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
if vttablet.DbFlavor != "" {
vttablet.proc.Args = append(vttablet.proc.Args, fmt.Sprintf("--db_flavor=%s", vttablet.DbFlavor))
}

10
go/test/endtoend/encryption/encryptedreplication/encrypted_replication_test.go
View File

@ -29,6 +29,7 @@ import (
"vitess.io/vitess/go/test/endtoend/cluster"
"vitess.io/vitess/go/test/endtoend/encryption"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/utils"
)
var (
@ -60,10 +61,11 @@ func testReplicationBase(t *testing.T, isClientCertPassed bool) {
replicaTablet := *clusterInstance.Keyspaces[0].Shards[0].Vttablets[1]
if isClientCertPassed {
replicaTablet.VttabletProcess.ExtraArgs = append(replicaTablet.VttabletProcess.ExtraArgs, "--db_flags", "2048",
"--db_ssl_ca", path.Join(certDirectory, "ca-cert.pem"),
"--db_ssl_cert", path.Join(certDirectory, "client-cert.pem"),
"--db_ssl_key", path.Join(certDirectory, "client-key.pem"),
replicaTablet.VttabletProcess.ExtraArgs = append(replicaTablet.VttabletProcess.ExtraArgs,
utils.GetFlagVariantForTests("--db-flags"), "2048",
utils.GetFlagVariantForTests("--db-ssl-ca"), path.Join(certDirectory, "ca-cert.pem"),
utils.GetFlagVariantForTests("--db-ssl-cert"), path.Join(certDirectory, "client-cert.pem"),
"--db-ssl-key", path.Join(certDirectory, "client-key.pem"),
)
}

29
go/test/endtoend/encryption/encryptedtransport/encrypted_transport_test.go
View File

@ -67,6 +67,7 @@ import (
"vitess.io/vitess/go/test/endtoend/encryption"
"vitess.io/vitess/go/vt/proto/vtrpc"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vterrors"
"github.com/stretchr/testify/assert"
@ -201,7 +202,7 @@ func useEffectiveCallerID(ctx context.Context, t *testing.T) {
// now restart vtgate in the mode where we don't use SSL
// for client connections, but we copy effective caller id
// into immediate caller id.
clusterInstance.VtGateExtraArgs = []string{"--grpc_use_effective_callerid"}
clusterInstance.VtGateExtraArgs = []string{utils.GetFlagVariantForTests("--grpc-use-effective-callerid")}
clusterInstance.VtGateExtraArgs = append(clusterInstance.VtGateExtraArgs, tabletConnExtraArgs("vttablet-client-1")...)
err := clusterInstance.RestartVtgate()
require.NoError(t, err)
@ -250,7 +251,7 @@ func useEffectiveGroups(ctx context.Context, t *testing.T) {
// now restart vtgate in the mode where we don't use SSL
// for client connections, but we copy effective caller's groups
// into immediate caller id.
clusterInstance.VtGateExtraArgs = []string{"--grpc_use_effective_callerid", "--grpc-use-effective-groups"}
clusterInstance.VtGateExtraArgs = []string{utils.GetFlagVariantForTests("--grpc-use-effective-callerid"), utils.GetFlagVariantForTests("--grpc-use-effective-groups")}
clusterInstance.VtGateExtraArgs = append(clusterInstance.VtGateExtraArgs, tabletConnExtraArgs("vttablet-client-1")...)
err := clusterInstance.RestartVtgate()
require.NoError(t, err)
@ -422,27 +423,29 @@ func createSignedCert(ca string, serial string, name string, commonName string)
}
func serverExtraArguments(name string, ca string) []string {
args := []string{"--grpc_cert", certDirectory + "/" + name + "-cert.pem",
"--grpc_key", certDirectory + "/" + name + "-key.pem",
"--grpc_ca", certDirectory + "/" + ca + "-cert.pem"}
args := []string{
utils.GetFlagVariantForTests("--grpc-cert"), certDirectory + "/" + name + "-cert.pem",
utils.GetFlagVariantForTests("--grpc-key"), certDirectory + "/" + name + "-key.pem",
utils.GetFlagVariantForTests("--grpc-ca"), certDirectory + "/" + ca + "-cert.pem",
}
return args
}
func tmclientExtraArgs(name string) []string {
ca := "vttablet-server"
var args = []string{"--tablet_manager_grpc_cert", certDirectory + "/" + name + "-cert.pem",
"--tablet_manager_grpc_key", certDirectory + "/" + name + "-key.pem",
"--tablet_manager_grpc_ca", certDirectory + "/" + ca + "-cert.pem",
"--tablet_manager_grpc_server_name", "vttablet server instance"}
var args = []string{"--tablet-manager-grpc-cert", certDirectory + "/" + name + "-cert.pem",
"--tablet-manager-grpc-key", certDirectory + "/" + name + "-key.pem",
"--tablet-manager-grpc-ca", certDirectory + "/" + ca + "-cert.pem",
"--tablet-manager-grpc-server-name", "vttablet server instance"}
return args
}
func tabletConnExtraArgs(name string) []string {
ca := "vttablet-server"
args := []string{"--tablet_grpc_cert", certDirectory + "/" + name + "-cert.pem",
"--tablet_grpc_key", certDirectory + "/" + name + "-key.pem",
"--tablet_grpc_ca", certDirectory + "/" + ca + "-cert.pem",
"--tablet_grpc_server_name", "vttablet server instance"}
args := []string{utils.GetFlagVariantForTests("--tablet-grpc-cert"), certDirectory + "/" + name + "-cert.pem",
utils.GetFlagVariantForTests("--tablet-grpc-key"), certDirectory + "/" + name + "-key.pem",
utils.GetFlagVariantForTests("--tablet-grpc-ca"), certDirectory + "/" + ca + "-cert.pem",
utils.GetFlagVariantForTests("--tablet-grpc-server-name"), "vttablet server instance"}
return args
}

9
go/test/endtoend/mysqlserver/main_test.go
View File

@ -25,6 +25,7 @@ import (
"vitess.io/vitess/go/mysql"
"vitess.io/vitess/go/test/endtoend/cluster"
"vitess.io/vitess/go/vt/utils"
)
var (
@ -64,8 +65,8 @@ func TestMain(m *testing.M) {
flag.Parse()
// setting grpc max size
if os.Getenv("grpc_max_massage_size") == "" {
os.Setenv("grpc_max_message_size", strconv.FormatInt(16*1024*1024, 10))
if os.Getenv("grpc-max-message-size") == "" {
os.Setenv("grpc-max-message-size", strconv.FormatInt(16*1024*1024, 10))
}
exitcode, err := func() (int, error) {
@ -110,9 +111,9 @@ func TestMain(m *testing.M) {
clusterInstance.VtGateExtraArgs = []string{
"--vschema_ddl_authorized_users=%",
"--mysql_server_query_timeout", "1s",
"--mysql_auth_server_impl", "static",
utils.GetFlagVariantForTests("--mysql-auth-server-impl"), "static",
"--mysql_auth_server_static_file", clusterInstance.TmpDirectory + mysqlAuthServerStatic,
"--mysql_server_version", "8.0.16-7",
utils.GetFlagVariantForTests("--mysql-server-version"), "8.0.16-7",
"--warn_sharded_only=true",
}

2
go/test/endtoend/mysqlserver/mysql_server_test.go
View File

@ -93,7 +93,7 @@ func TestInsertLargerThenGrpcLimit(t *testing.T) {
require.Nilf(t, err, "unable to connect mysql: %v", err)
defer conn.Close()
grpcLimit := os.Getenv("grpc_max_message_size")
grpcLimit := os.Getenv("grpc-max-message-size")
limit, err := strconv.Atoi(grpcLimit)
require.Nilf(t, err, "int parsing error: %v", err)

1
go/test/endtoend/onlineddl/flow/onlineddl_flow_test.go
View File

@ -138,6 +138,7 @@ func TestMain(m *testing.M) {
}
clusterInstance.VtTabletExtraArgs = []string{
// TODO: Replace flag with dashed version in v25
"--heartbeat_interval", "250ms",
"--heartbeat_on_demand_duration", "5s",
"--migration_check_interval", "2s",

2
go/test/endtoend/onlineddl/revert/onlineddl_revert_test.go
View File

@ -156,7 +156,7 @@ func TestMain(m *testing.M) {
}
clusterInstance.VtTabletExtraArgs = []string{
"--heartbeat_interval", "250ms",
"--heartbeat-interval", "250ms",
"--heartbeat_on_demand_duration", "5s",
"--migration_check_interval", "5s",
"--watch_replication_stream",

2
go/test/endtoend/onlineddl/scheduler/onlineddl_scheduler_test.go
View File

@ -252,7 +252,7 @@ func TestMain(m *testing.M) {
}
clusterInstance.VtTabletExtraArgs = []string{
"--heartbeat_interval", "250ms",
"--heartbeat-interval", "250ms",
"--heartbeat_on_demand_duration", "5s",
"--migration_check_interval", "2s",
"--watch_replication_stream",

2
go/test/endtoend/onlineddl/vrepl/onlineddl_vrepl_test.go
View File

@ -179,7 +179,7 @@ func TestMain(m *testing.M) {
}
clusterInstance.VtTabletExtraArgs = []string{
"--heartbeat_interval", "250ms",
"--heartbeat-interval", "250ms",
"--migration_check_interval", "5s",
"--watch_replication_stream",
}

2
go/test/endtoend/onlineddl/vrepl_stress/onlineddl_vrepl_mini_stress_test.go
View File

@ -178,7 +178,7 @@ func TestMain(m *testing.M) {
}
clusterInstance.VtTabletExtraArgs = []string{
"--heartbeat_interval", "250ms",
"--heartbeat-interval", "250ms",
"--heartbeat_on_demand_duration", "5s",
"--migration_check_interval", "5s",
"--watch_replication_stream",

4
go/test/endtoend/onlineddl/vrepl_stress_suite/onlineddl_vrepl_stress_suite_test.go
View File

@ -429,10 +429,10 @@ func TestMain(m *testing.M) {
// thereby examining lastPK on vcopier side. We will be iterating tables using non-PK order throughout
// this test suite, and so the low setting ensures we hit the more interesting code paths.
clusterInstance.VtTabletExtraArgs = []string{
"--heartbeat_interval", "250ms",
"--heartbeat-interval", "250ms",
"--heartbeat_on_demand_duration", "5s",
"--migration_check_interval", "5s",
"--vstream_packet_size", "4096", // Keep this value small and below 10k to ensure multilple vstream iterations
"--vstream-packet-size", "4096", // Keep this value small and below 10k to ensure multilple vstream iterations
"--watch_replication_stream",
}
clusterInstance.VtGateExtraArgs = []string{

1
go/test/endtoend/onlineddl/vrepl_suite/onlineddl_vrepl_suite_test.go
View File

@ -88,6 +88,7 @@ func TestMain(m *testing.M) {
}
clusterInstance.VtTabletExtraArgs = []string{
// TODO: Replace flag with dashed version in v25
"--heartbeat_interval", "250ms",
"--heartbeat_on_demand_duration", "5s",
"--migration_check_interval", "5s",

17
go/test/endtoend/recovery/recovery_util.go
View File

@ -26,6 +26,7 @@ import (
"github.com/stretchr/testify/require"
"vitess.io/vitess/go/test/endtoend/cluster"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vtgate/vtgateconn"
)
@ -36,10 +37,10 @@ var (
UseXb = false
// XbArgs are the arguments for specifying xtrabackup.
XbArgs = []string{
"--backup_engine_implementation", "xtrabackup",
"--xtrabackup_stream_mode=xbstream",
"--xtrabackup_user=vt_dba",
"--xtrabackup_backup_flags", fmt.Sprintf("--password=%s", dbPassword),
utils.GetFlagVariantForTests("--backup-engine-implementation"), "xtrabackup",
fmt.Sprintf("%s=xbstream", utils.GetFlagVariantForTests("--xtrabackup-stream-mode")),
fmt.Sprintf("%s=vt_dba", utils.GetFlagVariantForTests("--xtrabackup-user")),
utils.GetFlagVariantForTests("--xtrabackup-backup-flags"), fmt.Sprintf("--password=%s", dbPassword),
}
)
@ -73,10 +74,10 @@ func RestoreTablet(t *testing.T, localCluster *cluster.LocalProcessCluster, tabl
}
replicaTabletArgs = append(replicaTabletArgs,
"--enable_replication_reporter=false",
"--init_tablet_type", "replica",
"--init_keyspace", restoreKSName,
"--init_shard", shardName,
"--init_db_name_override", "vt_"+keyspaceName,
utils.GetFlagVariantForTests("--init-tablet-type"), "replica",
utils.GetFlagVariantForTests("--init-keyspace"), restoreKSName,
utils.GetFlagVariantForTests("--init-shard"), shardName,
utils.GetFlagVariantForTests("--init-db-name-override"), "vt_"+keyspaceName,
)
tablet.VttabletProcess.SupportsBackup = true
tablet.VttabletProcess.ExtraArgs = replicaTabletArgs

2
go/test/endtoend/reparent/newfeaturetest/reparent_test.go
View File

@ -40,7 +40,7 @@ import (
// even when there are multiple vttablet failures. In this test we use the semi_sync policy
// to allow multiple failures to happen and still be recoverable.
// The test takes down the vttablets of the primary and a rdonly tablet and runs ERS with the
// default values of remote_operation_timeout, lock-timeout flags and wait_replicas_timeout subflag.
// default values of remote-operation-timeout, lock-timeout flags and wait_replicas_timeout subflag.
func TestRecoverWithMultipleVttabletFailures(t *testing.T) {
clusterInstance := utils.SetupReparentCluster(t, policy.DurabilitySemiSync)
defer utils.TeardownCluster(clusterInstance)

2
go/test/endtoend/schemadiff/vrepl/schemadiff_vrepl_suite_test.go
View File

@ -87,7 +87,7 @@ func TestMain(m *testing.M) {
}
clusterInstance.VtTabletExtraArgs = []string{
"--heartbeat_interval", "250ms",
"--heartbeat-interval", "250ms",
"--heartbeat_on_demand_duration", "5s",
"--migration_check_interval", "5s",
"--watch_replication_stream",

5
go/test/endtoend/tabletgateway/buffer/buffer_test_helpers.go
View File

@ -48,6 +48,7 @@ import (
"vitess.io/vitess/go/mysql"
"vitess.io/vitess/go/test/endtoend/cluster"
vtutils "vitess.io/vitess/go/vt/utils"
)
const (
@ -216,7 +217,7 @@ func (bt *BufferingTest) createCluster() (*cluster.LocalProcessCluster, int) {
clusterInstance := cluster.NewCluster(cell, hostname)
// Start topo server
clusterInstance.VtctldExtraArgs = []string{"--remote_operation_timeout", "30s", "--topo_etcd_lease_ttl", "40"}
clusterInstance.VtctldExtraArgs = []string{vtutils.GetFlagVariantForTests("--remote-operation-timeout"), "30s", "--topo-etcd-lease-ttl", "40"}
if err := clusterInstance.StartTopo(); err != nil {
return nil, 1
}
@ -241,7 +242,7 @@ func (bt *BufferingTest) createCluster() (*cluster.LocalProcessCluster, int) {
"--buffer_window", "10m",
"--buffer_max_failover_duration", "10m",
"--buffer_min_time_between_failovers", "20m",
"--tablet_refresh_interval", "1s",
vtutils.GetFlagVariantForTests("--tablet-refresh-interval"), "1s",
"--buffer_drain_concurrency", "4",
}
clusterInstance.VtGateExtraArgs = append(clusterInstance.VtGateExtraArgs, bt.VtGateExtraArgs...)

3
go/test/endtoend/tabletmanager/main_test.go
View File

@ -28,6 +28,7 @@ import (
"vitess.io/vitess/go/mysql"
"vitess.io/vitess/go/test/endtoend/cluster"
tabletpb "vitess.io/vitess/go/vt/proto/topodata"
"vitess.io/vitess/go/vt/utils"
tmc "vitess.io/vitess/go/vt/vttablet/grpctmclient"
)
@ -101,7 +102,7 @@ func TestMain(m *testing.M) {
clusterInstance.VtTabletExtraArgs = []string{
"--lock_tables_timeout", "5s",
"--watch_replication_stream",
"--heartbeat_enable",
utils.GetFlagVariantForTests("--heartbeat-enable"),
"--health_check_interval", tabletHealthcheckRefreshInterval.String(),
"--unhealthy_threshold", tabletUnhealthyThreshold.String(),
"--twopc_abandon_age", "200",

5
go/test/endtoend/tabletmanager/replication_manager/tablet_test.go
View File

@ -25,6 +25,7 @@ import (
"time"
"vitess.io/vitess/go/vt/sidecardb"
"vitess.io/vitess/go/vt/utils"
"github.com/stretchr/testify/require"
@ -129,8 +130,8 @@ func getTablet(tabletGrpcPort int) *tabletpb.Tablet {
func resurrectTablet(t *testing.T, tab cluster.Vttablet) {
// initialize config again to regenerate the my.cnf file which has the port to use
_, err := tab.MysqlctlProcess.ExecuteCommandWithOutput("--log_dir", tab.MysqlctlProcess.LogDirectory,
"--tablet_uid", fmt.Sprintf("%d", tab.MysqlctlProcess.TabletUID),
"--mysql_port", fmt.Sprintf("%d", tab.MysqlctlProcess.MySQLPort),
utils.GetFlagVariantForTests("--tablet-uid"), fmt.Sprintf("%d", tab.MysqlctlProcess.TabletUID),
utils.GetFlagVariantForTests("--mysql-port"), fmt.Sprintf("%d", tab.MysqlctlProcess.MySQLPort),
"init_config")
require.NoError(t, err)

3
go/test/endtoend/tabletmanager/tablegc/tablegc_test.go
View File

@ -28,6 +28,7 @@ import (
"vitess.io/vitess/go/mysql/capabilities"
"vitess.io/vitess/go/vt/schema"
"vitess.io/vitess/go/vt/sqlparser"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vttablet/tabletserver/gc"
"vitess.io/vitess/go/test/endtoend/cluster"
@ -100,7 +101,7 @@ func TestMain(m *testing.M) {
"--lock_tables_timeout", "5s",
"--watch_replication_stream",
"--enable_replication_reporter",
"--heartbeat_interval", "250ms",
utils.GetFlagVariantForTests("--heartbeat-interval"), "250ms",
"--gc_check_interval", gcCheckInterval.String(),
"--gc_purge_check_interval", gcPurgeCheckInterval.String(),
"--table_gc_lifecycle", "hold,purge,evac,drop",

7
go/test/endtoend/tabletmanager/tablet_health_test.go
View File

@ -35,6 +35,7 @@ import (
"vitess.io/vitess/go/test/endtoend/utils"
querypb "vitess.io/vitess/go/vt/proto/query"
topodatapb "vitess.io/vitess/go/vt/proto/topodata"
vtutils "vitess.io/vitess/go/vt/utils"
)
// TabletReshuffle test if a vttablet can be pointed at an existing mysql
@ -57,14 +58,14 @@ func TestTabletReshuffle(t *testing.T) {
// Create new tablet
rTablet := clusterInstance.NewVttabletInstance("replica", 0, "")
// mycnf_server_id prevents vttablet from reading the mycnf
// mycnf-server-id prevents vttablet from reading the mycnf
// Pointing to primaryTablet's socket file
// We have to disable active reparenting to prevent the tablet from trying to fix replication.
// We also have to disable replication reporting because we're pointed at the primary.
clusterInstance.VtTabletExtraArgs = []string{
"--lock_tables_timeout", "5s",
"--mycnf_server_id", fmt.Sprintf("%d", rTablet.TabletUID),
"--db_socket", fmt.Sprintf("%s/mysql.sock", primaryTablet.VttabletProcess.Directory),
vtutils.GetFlagVariantForTests("--mycnf-server-id"), fmt.Sprintf("%d", rTablet.TabletUID),
vtutils.GetFlagVariantForTests("--db-socket"), fmt.Sprintf("%s/mysql.sock", primaryTablet.VttabletProcess.Directory),
"--enable_replication_reporter=false",
}
defer func() { clusterInstance.VtTabletExtraArgs = []string{} }()

13
go/test/endtoend/tabletmanager/tablet_security_policy_test.go
View File

@ -26,6 +26,7 @@ import (
"github.com/stretchr/testify/require"
"vitess.io/vitess/go/test/endtoend/cluster"
"vitess.io/vitess/go/vt/utils"
)
func TestFallbackSecurityPolicy(t *testing.T) {
@ -36,8 +37,8 @@ func TestFallbackSecurityPolicy(t *testing.T) {
err := cluster.StartMySQL(ctx, mTablet, username, clusterInstance.TmpDirectory)
require.NoError(t, err)
// Requesting an unregistered security_policy should fallback to deny-all.
clusterInstance.VtTabletExtraArgs = []string{"--security_policy", "bogus"}
// Requesting an unregistered security-policy should fallback to deny-all.
clusterInstance.VtTabletExtraArgs = []string{utils.GetFlagVariantForTests("--security-policy"), "bogus"}
err = clusterInstance.StartVttablet(mTablet, false, "SERVING", false, cell, keyspaceName, hostname, shardName)
require.NoError(t, err)
@ -90,8 +91,8 @@ func TestDenyAllSecurityPolicy(t *testing.T) {
err := cluster.StartMySQL(ctx, mTablet, username, clusterInstance.TmpDirectory)
require.NoError(t, err)
// Requesting a deny-all security_policy.
clusterInstance.VtTabletExtraArgs = []string{"--security_policy", "deny-all"}
// Requesting a deny-all security-policy.
clusterInstance.VtTabletExtraArgs = []string{utils.GetFlagVariantForTests("--security-policy"), "deny-all"}
err = clusterInstance.StartVttablet(mTablet, false, "SERVING", false, cell, keyspaceName, hostname, shardName)
require.NoError(t, err)
@ -121,8 +122,8 @@ func TestReadOnlySecurityPolicy(t *testing.T) {
err := cluster.StartMySQL(ctx, mTablet, username, clusterInstance.TmpDirectory)
require.NoError(t, err)
// Requesting a read-only security_policy.
clusterInstance.VtTabletExtraArgs = []string{"--security_policy", "read-only"}
// Requesting a read-only security-policy.
clusterInstance.VtTabletExtraArgs = []string{utils.GetFlagVariantForTests("--security-policy"), "read-only"}
err = clusterInstance.StartVttablet(mTablet, false, "SERVING", false, cell, keyspaceName, hostname, shardName)
require.NoError(t, err)

3
go/test/endtoend/tabletmanager/throttler_topo/throttler_test.go
View File

@ -32,6 +32,7 @@ import (
"vitess.io/vitess/go/sqltypes"
"vitess.io/vitess/go/test/endtoend/cluster"
"vitess.io/vitess/go/test/endtoend/throttler"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vttablet/tabletserver/throttle"
"vitess.io/vitess/go/vt/vttablet/tabletserver/throttle/base"
"vitess.io/vitess/go/vt/vttablet/tabletserver/throttle/throttlerapp"
@ -107,7 +108,7 @@ func TestMain(m *testing.M) {
"--lock_tables_timeout", "5s",
"--watch_replication_stream",
"--enable_replication_reporter",
"--heartbeat_interval", "250ms",
utils.GetFlagVariantForTests("--heartbeat-interval"), "250ms",
"--heartbeat_on_demand_duration", onDemandHeartbeatDuration.String(),
}

3
go/test/endtoend/transaction/rollback/txn_rollback_shutdown_test.go
View File

@ -31,6 +31,7 @@ import (
"vitess.io/vitess/go/mysql"
"vitess.io/vitess/go/test/endtoend/cluster"
vtutils "vitess.io/vitess/go/vt/utils"
)
var (
@ -74,7 +75,7 @@ func TestMain(m *testing.M) {
}
// Set a short onterm timeout so the test goes faster.
clusterInstance.VtGateExtraArgs = []string{"--onterm_timeout", "1s"}
clusterInstance.VtGateExtraArgs = []string{vtutils.GetFlagVariantForTests("--onterm-timeout"), "1s"}
err = clusterInstance.StartVtgate()
if err != nil {
panic(err)

Some files were not shown because too many files have changed in this diff Show More