Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sync cobradocs #1605

Merged
merged 4 commits into from
Sep 28, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion content/en/docs/18.0/reference/programs/mysqlctl/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: mysqlctl
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
---
## mysqlctl

Expand All @@ -24,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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unfortunately this is gonna generate some unnecessary churn until i get to #1601 (which i'm working on separately)

--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
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: init
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
---
## mysqlctl init

Expand Down Expand Up @@ -43,7 +44,7 @@ mysqlctl \
--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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: init config
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
---
## mysqlctl init_config

Expand Down Expand Up @@ -41,7 +42,7 @@ mysqlctl \
--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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: position
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
---
## mysqlctl position

Expand All @@ -26,7 +27,7 @@ mysqlctl position <operation> <pos1> <pos2 | gtid> [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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: reinit config
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
---
## mysqlctl reinit_config

Expand Down Expand Up @@ -41,7 +42,7 @@ mysqlctl \
--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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: shutdown
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
---
## mysqlctl shutdown

Expand Down Expand Up @@ -39,7 +40,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr shutdown
--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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: start
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
---
## mysqlctl start

Expand Down Expand Up @@ -38,7 +39,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr start
--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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: teardown
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
---
## mysqlctl teardown

Expand Down Expand Up @@ -42,7 +43,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr teardown
--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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
3 changes: 2 additions & 1 deletion content/en/docs/18.0/reference/programs/mysqlctld/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: mysqlctld
series: mysqlctld
commit: b089f78945653f6acd17c66f896820e36df49437
---
## mysqlctld

Expand Down Expand Up @@ -42,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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
Original file line number Diff line number Diff line change
Expand Up @@ -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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
3 changes: 2 additions & 1 deletion content/en/docs/18.0/reference/programs/vtaclcheck/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: vtaclcheck
series: vtaclcheck
commit: b089f78945653f6acd17c66f896820e36df49437
---
## vtaclcheck

Expand All @@ -18,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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
3 changes: 2 additions & 1 deletion content/en/docs/18.0/reference/programs/vtbackup/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: vtbackup
series: vtbackup
commit: b089f78945653f6acd17c66f896820e36df49437
---
## vtbackup

Expand Down Expand Up @@ -79,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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
3 changes: 2 additions & 1 deletion content/en/docs/18.0/reference/programs/vtclient/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: vtclient
series: vtclient
commit: b089f78945653f6acd17c66f896820e36df49437
---
## vtclient

Expand Down Expand Up @@ -33,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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
4 changes: 2 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: 476ca265d0583549c05a3ab88f76bc8d24174364
commit: b089f78945653f6acd17c66f896820e36df49437
---
## 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/vitess])
--config-path strings Paths to search for config files in. (default [/Users/andrew/dev/vtwebsite/vitessio.website/vitess])
--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
Loading