Skip to content

Commit

Permalink
Docs: Backup/BackupShard --incremental-from-pos accepts backup name (#…
Browse files Browse the repository at this point in the history
…1667)

* Documenting the behavior of '--incremental-from-pos=<backup-name>'

Signed-off-by: Shlomi Noach <[email protected]>

* sync cobradocs to latest release branches

Signed-off-by: Shlomi Noach <[email protected]>

* sync cobradocs to latest release branches

Signed-off-by: Shlomi Noach <[email protected]>

* Update docs

Signed-off-by: Shlomi Noach <[email protected]>

---------

Signed-off-by: Shlomi Noach <[email protected]>
  • Loading branch information
shlomi-noach authored Jan 29, 2024
1 parent 51dc96c commit baa4d3f
Show file tree
Hide file tree
Showing 48 changed files with 106 additions and 67 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyRoutingRules
series: vtctldclient
commit: 9a3d0f4a69a840cfa2cb86654abd4afa0be6e0aa
commit: 9a3628037518bc108c636220319f3c7385b2a559
---
## vtctldclient ApplyRoutingRules

Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyRoutingRules
series: vtctldclient
commit: 9a6f5262f7707ff80ce85c111d2ff686d85d29cc
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## vtctldclient ApplyRoutingRules

Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: VDiff create
series: vtctldclient
commit: 9a6f5262f7707ff80ce85c111d2ff686d85d29cc
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## vtctldclient VDiff create

Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion content/en/docs/19.0/reference/programs/mysqlctl/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: mysqlctl
series: mysqlctl
commit: c823b86a19bfeb9a6a411a75caf492464caf697e
commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90
---
## mysqlctl

Expand Down Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: init
series: mysqlctl
commit: c823b86a19bfeb9a6a411a75caf492464caf697e
commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90
---
## mysqlctl init

Expand Down Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: init config
series: mysqlctl
commit: c823b86a19bfeb9a6a411a75caf492464caf697e
commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90
---
## mysqlctl init_config

Expand Down Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: position
series: mysqlctl
commit: c823b86a19bfeb9a6a411a75caf492464caf697e
commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90
---
## mysqlctl position

Expand Down Expand Up @@ -81,6 +81,7 @@ mysqlctl position <operation> <pos1> <pos2 | gtid> [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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: reinit config
series: mysqlctl
commit: c823b86a19bfeb9a6a411a75caf492464caf697e
commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90
---
## mysqlctl reinit_config

Expand Down Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: shutdown
series: mysqlctl
commit: c823b86a19bfeb9a6a411a75caf492464caf697e
commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90
---
## mysqlctl shutdown

Expand Down Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: start
series: mysqlctl
commit: c823b86a19bfeb9a6a411a75caf492464caf697e
commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90
---
## mysqlctl start

Expand Down Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: teardown
series: mysqlctl
commit: c823b86a19bfeb9a6a411a75caf492464caf697e
commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90
---
## mysqlctl teardown

Expand Down Expand Up @@ -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)
Expand Down
3 changes: 2 additions & 1 deletion content/en/docs/19.0/reference/programs/mysqlctld/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: mysqlctld
series: mysqlctld
commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9
commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90
---
## mysqlctld

Expand Down Expand Up @@ -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)
Expand Down
3 changes: 2 additions & 1 deletion content/en/docs/19.0/reference/programs/topo2topo/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: topo2topo
series: topo2topo
commit: c823b86a19bfeb9a6a411a75caf492464caf697e
commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90
---
## topo2topo

Expand Down Expand Up @@ -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)
Expand Down
3 changes: 2 additions & 1 deletion content/en/docs/19.0/reference/programs/vtaclcheck/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtaclcheck
series: vtaclcheck
commit: c823b86a19bfeb9a6a411a75caf492464caf697e
commit: 2642bea6b1d3476889564c49ed64829f2a3d0a90
---
## vtaclcheck

Expand Down Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions content/en/docs/19.0/reference/programs/vtbackup/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtbackup
series: vtbackup
commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9
commit: 20b1e461f3710f368a04eb0b563fd3de3df56908
---
## vtbackup

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
Loading

0 comments on commit baa4d3f

Please sign in to comment.