From baa4d3fda70064cc29e5fe32257229cc77b54876 Mon Sep 17 00:00:00 2001 From: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> Date: Mon, 29 Jan 2024 15:44:09 +0200 Subject: [PATCH] Docs: Backup/BackupShard --incremental-from-pos accepts backup name (#1667) * Documenting the behavior of '--incremental-from-pos=' Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * sync cobradocs to latest release branches Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * sync cobradocs to latest release branches Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * Update docs Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> --------- Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> --- .../vtctldclient/vtctldclient_ApplyRoutingRules.md | 4 ++-- .../vtctldclient/vtctldclient_ApplyRoutingRules.md | 4 ++-- .../vtctldclient_VDiff/vtctldclient_VDiff_create.md | 6 +++--- .../docs/19.0/reference/programs/mysqlctl/_index.md | 3 ++- .../reference/programs/mysqlctl/mysqlctl_init.md | 3 ++- .../programs/mysqlctl/mysqlctl_init_config.md | 3 ++- .../reference/programs/mysqlctl/mysqlctl_position.md | 3 ++- .../programs/mysqlctl/mysqlctl_reinit_config.md | 3 ++- .../reference/programs/mysqlctl/mysqlctl_shutdown.md | 3 ++- .../reference/programs/mysqlctl/mysqlctl_start.md | 3 ++- .../reference/programs/mysqlctl/mysqlctl_teardown.md | 3 ++- .../docs/19.0/reference/programs/mysqlctld/_index.md | 3 ++- .../docs/19.0/reference/programs/topo2topo/_index.md | 3 ++- .../19.0/reference/programs/vtaclcheck/_index.md | 3 ++- .../docs/19.0/reference/programs/vtbackup/_index.md | 5 +++-- .../docs/19.0/reference/programs/vtclient/_index.md | 3 ++- .../docs/19.0/reference/programs/vtcombo/_index.md | 3 ++- .../en/docs/19.0/reference/programs/vtctld/_index.md | 4 +++- .../vtctldclient/vtctldclient_ApplyVSchema.md | 5 +++-- .../programs/vtctldclient/vtctldclient_Backup.md | 8 ++++---- .../vtctldclient/vtctldclient_BackupShard.md | 8 ++++---- .../vtctldclient_Materialize_create.md | 5 ++++- .../vtctldclient_MoveTables_cancel.md | 2 +- .../vtctldclient_MoveTables_complete.md | 2 +- .../vtctldclient_MoveTables_reversetraffic.md | 2 +- .../vtctldclient_MoveTables_show.md | 2 +- .../vtctldclient_MoveTables_status.md | 2 +- .../vtctldclient_MoveTables_switchtraffic.md | 2 +- .../vtctldclient_ReloadSchemaKeyspace.md | 8 ++++---- .../vtctldclient/vtctldclient_ReloadSchemaShard.md | 8 ++++---- .../vtctldclient_VDiff/vtctldclient_VDiff_create.md | 3 ++- .../vtctldclient_Workflow_delete.md | 2 +- .../vtctldclient_Workflow_list.md | 2 +- .../vtctldclient_Workflow_show.md | 2 +- .../vtctldclient_Workflow_start.md | 2 +- .../vtctldclient_Workflow_stop.md | 2 +- .../vtctldclient_Workflow_update.md | 2 +- .../en/docs/19.0/reference/programs/vtgate/_index.md | 3 ++- .../reference/programs/vtgateclienttest/_index.md | 3 ++- .../en/docs/19.0/reference/programs/vtorc/_index.md | 3 ++- .../docs/19.0/reference/programs/vttablet/_index.md | 3 ++- .../19.0/reference/programs/vttestserver/_index.md | 3 ++- .../en/docs/19.0/reference/programs/zkctl/_index.md | 3 ++- .../docs/19.0/reference/programs/zkctl/zkctl_init.md | 3 ++- .../19.0/reference/programs/zkctl/zkctl_shutdown.md | 3 ++- .../19.0/reference/programs/zkctl/zkctl_start.md | 3 ++- .../19.0/reference/programs/zkctl/zkctl_teardown.md | 3 ++- .../backup-and-restore/creating-a-backup.md | 12 ++++++++++-- 48 files changed, 106 insertions(+), 67 deletions(-) diff --git a/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md b/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md index 9268f9b36..7dc7fd564 100644 --- a/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md +++ b/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md @@ -1,7 +1,7 @@ --- title: ApplyRoutingRules series: vtctldclient -commit: 9a3d0f4a69a840cfa2cb86654abd4afa0be6e0aa +commit: 9a3628037518bc108c636220319f3c7385b2a559 --- ## vtctldclient ApplyRoutingRules @@ -14,7 +14,7 @@ vtctldclient ApplyRoutingRules {--rules RULES | --rules-file RULES_FILE} [--cell ### Options ``` - -c, --cells strings Limit the VSchema graph rebuildingg to the specified cells. Ignored if --skip-rebuild is specified. + -c, --cells strings Limit the VSchema graph rebuilding to the specified cells. Ignored if --skip-rebuild is specified. -d, --dry-run Load the specified routing rules as a validation step, but do not actually apply the rules to the topo. -h, --help help for ApplyRoutingRules -r, --rules string Routing rules, specified as a string. diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md index 78498d2fe..54d393956 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md @@ -1,7 +1,7 @@ --- title: ApplyRoutingRules series: vtctldclient -commit: 9a6f5262f7707ff80ce85c111d2ff686d85d29cc +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## vtctldclient ApplyRoutingRules @@ -14,7 +14,7 @@ vtctldclient ApplyRoutingRules {--rules RULES | --rules-file RULES_FILE} [--cell ### Options ``` - -c, --cells strings Limit the VSchema graph rebuildingg to the specified cells. Ignored if --skip-rebuild is specified. + -c, --cells strings Limit the VSchema graph rebuilding to the specified cells. Ignored if --skip-rebuild is specified. -d, --dry-run Load the specified routing rules as a validation step, but do not actually apply the rules to the topo. -h, --help help for ApplyRoutingRules -r, --rules string Routing rules, specified as a string. diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_create.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_create.md index 42221e353..29cd37d4f 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_create.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_create.md @@ -1,7 +1,7 @@ --- title: VDiff create series: vtctldclient -commit: 9a6f5262f7707ff80ce85c111d2ff686d85d29cc +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## vtctldclient VDiff create @@ -25,8 +25,8 @@ vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --targe --debug-query Adds a mysql query to the report that can be used for further debugging. --filtered-replication-wait-time duration Specifies the maximum time to wait, in seconds, for replication to catch up when syncing tablet streams. (default 30s) -h, --help help for create - --limit uint32 Max rows to stop comparing after. (default 4294967295) - --max-extra-rows-to-compare uint32 If there are collation differences between the source and target, you can have rows that are identical but simply returned in a different order from MySQL. We will do a second pass to compare the rows for any actual differences in this case and this flag allows you to control the resources used for this operation. (default 1000) + --limit int Max rows to stop comparing after. (default 9223372036854775807) + --max-extra-rows-to-compare int If there are collation differences between the source and target, you can have rows that are identical but simply returned in a different order from MySQL. We will do a second pass to compare the rows for any actual differences in this case and this flag allows you to control the resources used for this operation. (default 1000) --only-pks When reporting missing rows, only show primary keys in the report. --source-cells strings The source cell(s) to compare from; default is any available cell. --tables strings Only run vdiff for these tables in the workflow. diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/_index.md b/content/en/docs/19.0/reference/programs/mysqlctl/_index.md index 220d89b20..efac92b3f 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/_index.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/_index.md @@ -1,7 +1,7 @@ --- title: mysqlctl series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## mysqlctl @@ -80,6 +80,7 @@ This helps ensure that `mysqld` is automatically restarted after failures. --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 (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init.md index 60bb965ad..7ee95d315 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init.md @@ -1,7 +1,7 @@ --- title: init series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## mysqlctl init @@ -98,6 +98,7 @@ mysqlctl \ --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 (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init_config.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init_config.md index 1d51bccc5..5feceae61 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init_config.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init_config.md @@ -1,7 +1,7 @@ --- title: init config series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## mysqlctl init_config @@ -96,6 +96,7 @@ mysqlctl \ --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 (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_position.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_position.md index 533781f90..f2f63df59 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_position.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_position.md @@ -1,7 +1,7 @@ --- title: position series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## mysqlctl position @@ -81,6 +81,7 @@ mysqlctl position [flags] --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 (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md index 34d756268..28e1f13b2 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md @@ -1,7 +1,7 @@ --- title: reinit config series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## mysqlctl reinit_config @@ -96,6 +96,7 @@ mysqlctl \ --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 (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_shutdown.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_shutdown.md index 4f6cec9ed..b7f43c725 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_shutdown.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_shutdown.md @@ -1,7 +1,7 @@ --- title: shutdown series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## mysqlctl shutdown @@ -94,6 +94,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr shutdown --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 (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_start.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_start.md index 69d80819c..ed618ef6a 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_start.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_start.md @@ -1,7 +1,7 @@ --- title: start series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## mysqlctl start @@ -93,6 +93,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr start --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 (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_teardown.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_teardown.md index 9ea036d59..530d4b275 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_teardown.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_teardown.md @@ -1,7 +1,7 @@ --- title: teardown series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## mysqlctl teardown @@ -97,6 +97,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr teardown --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 (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/mysqlctld/_index.md b/content/en/docs/19.0/reference/programs/mysqlctld/_index.md index be3ce512d..70523f0a1 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctld/_index.md +++ b/content/en/docs/19.0/reference/programs/mysqlctld/_index.md @@ -1,7 +1,7 @@ --- title: mysqlctld series: mysqlctld -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## mysqlctld @@ -123,6 +123,7 @@ mysqlctld \ --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 (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/topo2topo/_index.md b/content/en/docs/19.0/reference/programs/topo2topo/_index.md index 98cda6967..d176cf0d4 100644 --- a/content/en/docs/19.0/reference/programs/topo2topo/_index.md +++ b/content/en/docs/19.0/reference/programs/topo2topo/_index.md @@ -1,7 +1,7 @@ --- title: topo2topo series: topo2topo -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## topo2topo @@ -47,6 +47,7 @@ topo2topo [flags] --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 (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/vtaclcheck/_index.md b/content/en/docs/19.0/reference/programs/vtaclcheck/_index.md index 6f5619789..926cc2cb8 100644 --- a/content/en/docs/19.0/reference/programs/vtaclcheck/_index.md +++ b/content/en/docs/19.0/reference/programs/vtaclcheck/_index.md @@ -1,7 +1,7 @@ --- title: vtaclcheck series: vtaclcheck -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## vtaclcheck @@ -31,6 +31,7 @@ vtaclcheck [flags] --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 (default true) --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 diff --git a/content/en/docs/19.0/reference/programs/vtbackup/_index.md b/content/en/docs/19.0/reference/programs/vtbackup/_index.md index b0d55e727..e0e6c2b9f 100644 --- a/content/en/docs/19.0/reference/programs/vtbackup/_index.md +++ b/content/en/docs/19.0/reference/programs/vtbackup/_index.md @@ -1,7 +1,7 @@ --- title: vtbackup series: vtbackup -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: 20b1e461f3710f368a04eb0b563fd3de3df56908 --- ## vtbackup @@ -151,7 +151,7 @@ vtbackup [flags] --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 of previous backup. Default: empty. If given, then this backup becomes an incremental backup from given position. If value is 'auto', backup taken from last successful backup position + --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_sql_file string path to .sql file to run after mysql_install_db --init_keyspace string (init parameter) keyspace to use for this tablet @@ -196,6 +196,7 @@ vtbackup [flags] --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 (default true) --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. diff --git a/content/en/docs/19.0/reference/programs/vtclient/_index.md b/content/en/docs/19.0/reference/programs/vtclient/_index.md index 6dd4d0e11..2525fde9c 100644 --- a/content/en/docs/19.0/reference/programs/vtclient/_index.md +++ b/content/en/docs/19.0/reference/programs/vtclient/_index.md @@ -1,7 +1,7 @@ --- title: vtclient series: vtclient -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## vtclient @@ -55,6 +55,7 @@ vtclient --server vtgate:15991 --target '@primary' --bind_variables '[ 12345, 1, --mysql_server_version string MySQL server version to advertise. (default "8.0.30-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 (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/vtcombo/_index.md b/content/en/docs/19.0/reference/programs/vtcombo/_index.md index 1f8e92a41..854755705 100644 --- a/content/en/docs/19.0/reference/programs/vtcombo/_index.md +++ b/content/en/docs/19.0/reference/programs/vtcombo/_index.md @@ -1,7 +1,7 @@ --- title: vtcombo series: vtcombo -commit: 6b481a7dc8639a070f8aa42773aa9c5a497f79c7 +commit: a85c612dc9a58aa2e4b13010fdba99e246646618 --- ## vtcombo @@ -270,6 +270,7 @@ vtcombo [flags] --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 (default true) --proto_topo vttest.TopoData vttest proto definition of the topology, encoded in compact text format. See vttest.proto for more information. --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 diff --git a/content/en/docs/19.0/reference/programs/vtctld/_index.md b/content/en/docs/19.0/reference/programs/vtctld/_index.md index c785bafde..a4d418d64 100644 --- a/content/en/docs/19.0/reference/programs/vtctld/_index.md +++ b/content/en/docs/19.0/reference/programs/vtctld/_index.md @@ -1,7 +1,7 @@ --- title: vtctld series: vtctld -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: a85c612dc9a58aa2e4b13010fdba99e246646618 --- ## vtctld @@ -111,12 +111,14 @@ vtctld \ --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.30-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. --port int port for the server --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --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) diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md index 64903834d..6eb595891 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md @@ -1,14 +1,14 @@ --- title: ApplyVSchema series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## vtctldclient ApplyVSchema Applies the VTGate routing schema to the provided keyspace. Shows the result after application. ``` -vtctldclient ApplyVSchema {--vschema= || --vschema-file= || --sql= || --sql-file=} [--cells=c1,c2,...] [--skip-rebuild] [--dry-run] +vtctldclient ApplyVSchema {--vschema= || --vschema-file= || --sql= || --sql-file=} [--cells=c1,c2,...] [--skip-rebuild] [--dry-run] [--strict] ``` ### Options @@ -20,6 +20,7 @@ vtctldclient ApplyVSchema {--vschema= || --vschema-file= --skip-rebuild Skip rebuilding the SrvSchema objects. --sql alter table t add vindex hash(id) A VSchema DDL SQL statement, e.g. alter table t add vindex hash(id). --sql-file string Path to a file containing a VSchema DDL SQL. + --strict If set, treat unknown vindex params as errors. --vschema string VSchema to apply, in JSON form. --vschema-file string Path to a file containing the vschema to apply, in JSON form. ``` diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Backup.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Backup.md index 4772e1066..946d1dc36 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Backup.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Backup.md @@ -1,23 +1,23 @@ --- title: Backup series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: 20b1e461f3710f368a04eb0b563fd3de3df56908 --- ## vtctldclient Backup Uses the BackupStorage service on the given tablet to create and store a new backup. ``` -vtctldclient Backup [--concurrency ] [--allow-primary] [--incremental-from-pos=|auto] [--upgrade-safe] +vtctldclient Backup [--concurrency ] [--allow-primary] [--incremental-from-pos=||auto] [--upgrade-safe] ``` ### Options ``` --allow-primary Allow the primary of a shard to be used for the backup. WARNING: If using the builtin backup engine, this will shutdown mysqld on the primary and stop writes for the duration of the backup. - --concurrency uint Specifies the number of compression/checksum jobs to run simultaneously. (default 4) + --concurrency int32 Specifies the number of compression/checksum jobs to run simultaneously. (default 4) -h, --help help for Backup - --incremental-from-pos string Position of previous backup. Default: empty. If given, then this backup becomes an incremental backup from given position. If value is 'auto', backup taken from last successful backup position + --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. --upgrade-safe Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades. ``` diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md index 4bd63ab39..95a4210a0 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md @@ -1,7 +1,7 @@ --- title: BackupShard series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: 20b1e461f3710f368a04eb0b563fd3de3df56908 --- ## vtctldclient BackupShard @@ -14,16 +14,16 @@ Finds the most up-to-date REPLICA, RDONLY, or SPARE tablet in the given shard an If no replica-type tablet can be found, the backup can be taken on the primary if --allow-primary is specified. ``` -vtctldclient BackupShard [--concurrency ] [--allow-primary] [--incremental-from-pos=|auto] [--upgrade-safe] +vtctldclient BackupShard [--concurrency ] [--allow-primary] [--incremental-from-pos=||auto] [--upgrade-safe] ``` ### Options ``` --allow-primary Allow the primary of a shard to be used for the backup. WARNING: If using the builtin backup engine, this will shutdown mysqld on the primary and stop writes for the duration of the backup. - --concurrency uint Specifies the number of compression/checksum jobs to run simultaneously. (default 4) + --concurrency int32 Specifies the number of compression/checksum jobs to run simultaneously. (default 4) -h, --help help for BackupShard - --incremental-from-pos string Position of previous backup. Default: empty. If given, then this backup becomes an incremental backup from given position. If value is 'auto', backup taken from last successful backup position + --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. --upgrade-safe Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades. ``` diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_create.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_create.md index 9e6d90175..dcc5e7dd6 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_create.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_create.md @@ -1,7 +1,7 @@ --- title: Materialize create series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## vtctldclient Materialize create @@ -52,7 +52,10 @@ vtctldclient --server localhost:15999 materialize --workflow product_sales --tar ``` -c, --cells strings Cells and/or CellAliases to copy table data from. -h, --help help for create + --mysql_server_version string Configure the MySQL version to use for example for the parser. (default "8.0.30-Vitess") --source-keyspace string Keyspace where the tables queried in the 'source_expression' values within table-settings live. + --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) --stop-after-copy Stop the workflow after it's finished copying the existing rows and before it starts replicating changes. --table-settings JSON A JSON array defining what tables to materialize using what select statements. See the --help output for more details. (default null) --tablet-types strings Source tablet types to replicate table data from (e.g. PRIMARY,REPLICA,RDONLY). diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md index b04369c39..7c99fee32 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md @@ -1,7 +1,7 @@ --- title: MoveTables cancel series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: a85c612dc9a58aa2e4b13010fdba99e246646618 --- ## vtctldclient MoveTables cancel diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md index 88fcc025c..a135d9296 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md @@ -1,7 +1,7 @@ --- title: MoveTables complete series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: a85c612dc9a58aa2e4b13010fdba99e246646618 --- ## vtctldclient MoveTables complete diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md index d67d87fc9..486caa272 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md @@ -1,7 +1,7 @@ --- title: MoveTables reversetraffic series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: a85c612dc9a58aa2e4b13010fdba99e246646618 --- ## vtctldclient MoveTables reversetraffic diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md index 68c35cf98..33bea71a3 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md @@ -1,7 +1,7 @@ --- title: MoveTables show series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: a85c612dc9a58aa2e4b13010fdba99e246646618 --- ## vtctldclient MoveTables show diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md index 383b8cde9..2804375df 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md @@ -1,7 +1,7 @@ --- title: MoveTables status series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: a85c612dc9a58aa2e4b13010fdba99e246646618 --- ## vtctldclient MoveTables status diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md index 3651c6717..3e85cae7e 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md @@ -1,7 +1,7 @@ --- title: MoveTables switchtraffic series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: a85c612dc9a58aa2e4b13010fdba99e246646618 --- ## vtctldclient MoveTables switchtraffic diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md index 91eea9f95..aa672d7b5 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md @@ -1,7 +1,7 @@ --- title: ReloadSchemaKeyspace series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## vtctldclient ReloadSchemaKeyspace @@ -14,9 +14,9 @@ vtctldclient ReloadSchemaKeyspace [--concurrency=] [--include-prima ### Options ``` - --concurrency uint32 Number of tablets to reload in parallel. Set to zero for unbounded concurrency. (default 10) - -h, --help help for ReloadSchemaKeyspace - --include-primary Also reload the primary tablets. + --concurrency int32 Number of tablets to reload in parallel. Set to zero for unbounded concurrency. (default 10) + -h, --help help for ReloadSchemaKeyspace + --include-primary Also reload the primary tablets. ``` ### Options inherited from parent commands diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md index 45f098a60..f55aa2822 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md @@ -1,7 +1,7 @@ --- title: ReloadSchemaShard series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90 --- ## vtctldclient ReloadSchemaShard @@ -14,9 +14,9 @@ vtctldclient ReloadSchemaShard [--concurrency=10] [--include-primary] : BackupShard [--allow_primary=f ## Create an incremental backup with vtctl -An incremental backup requires additional information: the point from which to start the backup. An incremental backup is taken by supplying `--incremental-from-pos` to the `Backup` or `BackupShard` command. The argument may either indicate a valid position, or the value `auto`. Examples: +An incremental backup requires additional information: the point from which to start the backup. An incremental backup is taken by supplying `--incremental-from-pos` to the `Backup` or `BackupShard` command. The argument may either indicate: + +- A valid position. +- A name of a successful backup. +- Or, the value `auto`. ```sh vtctldclient Backup --incremental-from-pos="MySQL56/0d7aaca6-1666-11ee-aeaf-0a43f95f28a3:1-53" zone1-0000000102 vtctldclient Backup --incremental-from-pos="0d7aaca6-1666-11ee-aeaf-0a43f95f28a3:1-53" zone1-0000000102 +vtctldclient Backup --incremental-from-pos="2024-01-10.062022.zone1-0000000101 commerce/0" zone1-0000000102 + vtctldclient Backup --incremental-from-pos="auto" zone1-0000000102 vtctldclient BackupShard --incremental-from-pos=auto commerce/0 ``` -When indicating a position, you may choose to use or to omit the `MySQL56/` prefix (which you can find in the backup manifest's Position). +When `--incremental-from-pos` supplies a position, you may choose to use or to omit the `MySQL56/` prefix (which you can find in the backup manifest's Position). + +When `--incremental-from-pos` indicates a backup name, that must be a successfully completed, existing backup. It may be either a full or an incremental backup. When `--incremental-from-pos="auto"`, Vitess chooses the position of the last successful backup as the starting point for the incremental backup. This is a convenient way to ensure a sequence of contiguous incremental backups.