Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
  • Loading branch information
frouioui committed Sep 25, 2023
1 parent 26b48f8 commit bbd2cdf
Show file tree
Hide file tree
Showing 136 changed files with 155 additions and 17 deletions.
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: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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
series: mysqlctl
commit: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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/vtaclcheck/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: vtaclcheck
series: vtaclcheck
commit: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## 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/florentpoinsard/Code/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: 3 additions & 1 deletion content/en/docs/18.0/reference/programs/vtcombo/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: vtcombo
series: vtcombo
commit: 71cd149b57652d80a123d1dd326a4bde6051afab
---
## vtcombo

Expand Down Expand Up @@ -59,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/florentpoinsard/Code/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 Expand Up @@ -152,6 +153,7 @@ vtcombo [flags]
--gc_check_interval duration Interval between garbage collection checks (default 1h0m0s)
--gc_purge_check_interval duration Interval between purge discovery checks (default 1m0s)
--gh-ost-path string override default gh-ost binary full path
--grpc-send-session-in-streaming If set, will send the session as last packet in streaming api to support transactions in streaming
--grpc-use-effective-groups If set, and SSL is not used, will set the immediate caller's security groups from the effective caller id's groups.
--grpc-use-static-authentication-callerid If set, will set the immediate caller id to the username authenticated by the static auth plugin.
--grpc_auth_mode string Which auth plugin implementation to use (eg: static)
Expand Down
Loading

0 comments on commit bbd2cdf

Please sign in to comment.