Skip to content

Commit

Permalink
sync cobradocs to latest release branches
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Mason <andrew@planetscale.com>
  • Loading branch information
Andrew Mason committed Sep 28, 2023
1 parent 5f6d442 commit 0c74b6a
Show file tree
Hide file tree
Showing 16 changed files with 38 additions and 31 deletions.
4 changes: 2 additions & 2 deletions content/en/docs/18.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: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## mysqlctl

Expand All @@ -25,7 +25,7 @@ This helps ensure that `mysqld` is automatically restarted after failures.
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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-credentials-file string db credentials file; send SIGHUP to reload this file
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.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: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## mysqlctld

Expand Down Expand Up @@ -43,7 +43,7 @@ mysqlctld \
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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-credentials-file string db credentials file; send SIGHUP to reload this file
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.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: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## topo2topo

Expand All @@ -24,7 +24,7 @@ topo2topo [flags]
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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).
--do-keyspaces copies the keyspace information
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.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: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## vtaclcheck

Expand All @@ -19,7 +19,7 @@ vtaclcheck [flags]
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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).
-h, --help help for vtaclcheck
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.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: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## vtbackup

Expand Down Expand Up @@ -80,7 +80,7 @@ vtbackup [flags]
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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.
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vtclient/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtclient
series: vtclient
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## vtclient

Expand Down Expand Up @@ -34,7 +34,7 @@ vtclient --server vtgate:15991 --target '@primary' --bind_variables '[ 12345, 1,
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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).
--count int DMLs only: Number of times each thread executes the query. Useful for simple, sustained load testing. (default 1)
Expand Down
6 changes: 4 additions & 2 deletions content/en/docs/18.0/reference/programs/vtcombo/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtcombo
series: vtcombo
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## vtcombo

Expand Down Expand Up @@ -60,7 +60,7 @@ vtcombo [flags]
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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).
--consolidator-stream-query-size int Configure the stream consolidator query size in bytes. Setting to 0 disables the stream consolidator. (default 2097152)
Expand Down Expand Up @@ -314,6 +314,8 @@ vtcombo [flags]
--relay_log_max_size int Maximum buffer size (in bytes) for VReplication target buffering. If single rows are larger than this, a single row is buffered at a time. (default 250000)
--remote_operation_timeout duration time to wait for a remote operation (default 15s)
--replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s)
--restore-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'
--restore_concurrency int (init restore parameter) how many concurrent files to restore at once (default 4)
--restore_from_backup (init restore parameter) will check BackupStorage for a recent backup at startup and start there
--restore_from_backup_ts string (init restore parameter) if set, restore the latest backup taken at or before this timestamp. Example: '2021-04-29.133050'
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vtctld/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtctld
series: vtctld
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## vtctld

Expand Down Expand Up @@ -61,7 +61,7 @@ vtctld \
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: VDiff create
series: vtctldclient
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## vtctldclient VDiff create

Expand Down Expand Up @@ -31,6 +31,7 @@ vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --targe
--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.
--tablet-types strings Tablet types to use on the source and target.
--tablet-types-in-preference-order When performing source tablet selection, look for candidates in the type order as they are listed in the tablet-types flag. (default true)
--target-cells strings The target cell(s) to compare with; default is any available cell.
--update-table-stats Update the table statistics, using ANALYZE TABLE, on each table involved in the VDiff during initialization. This will ensure that progress estimates are as accurate as possible -- but it does involve locks and can potentially impact query processing on the target keyspace.
--wait When creating or resuming a vdiff, wait for it to finish before exiting.
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vtgate/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtgate
series: vtgate
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## vtgate

Expand Down Expand Up @@ -57,7 +57,7 @@ vtgate \
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtgateclienttest
series: vtgateclienttest
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## vtgateclienttest

Expand All @@ -19,7 +19,7 @@ vtgateclienttest [flags]
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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).
--default_tablet_type topodatapb.TabletType The default tablet type to set for queries, when one is not explicitly selected. (default PRIMARY)
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vtorc/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtorc
series: vtorc
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 30385807689b40668d60dbb5059ea0987f19da5c
---
## vtorc

Expand Down Expand Up @@ -42,7 +42,7 @@ vtorc \
--config-file string Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
--config-file-not-found-handling ConfigFileNotFoundHandling Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
--config-name string Name of the config file (without extension) to search for. (default "vtconfig")
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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.
Expand Down
Loading

0 comments on commit 0c74b6a

Please sign in to comment.