From 93b99bb3a85e357d6f4b2bc6100802a4a3ed266d Mon Sep 17 00:00:00 2001 From: Dirkjan Bussink Date: Thu, 20 Jul 2023 09:17:47 +0200 Subject: [PATCH] Update docs for vtctldclient and flag name change Signed-off-by: Dirkjan Bussink --- .../docs/18.0/reference/programs/vtbackup.md | 2 +- .../18.0/reference/programs/vtctl/_index.md | 4 ++-- .../18.0/reference/programs/vtctl/shards.md | 2 +- .../18.0/reference/programs/vtctl/tablets.md | 4 ++-- .../vtctldclient/vtctldclient_ApplySchema.md | 3 +-- .../vtctldclient/vtctldclient_Backup.md | 4 ++-- .../vtctldclient/vtctldclient_BackupShard.md | 4 ++-- .../vtctldclient_UpdateThrottlerConfig.md | 20 +++++++++---------- .../backup-and-restore/creating-a-backup.md | 4 ++-- 9 files changed, 23 insertions(+), 24 deletions(-) diff --git a/content/en/docs/18.0/reference/programs/vtbackup.md b/content/en/docs/18.0/reference/programs/vtbackup.md index 1f138c463..afed9dc40 100644 --- a/content/en/docs/18.0/reference/programs/vtbackup.md +++ b/content/en/docs/18.0/reference/programs/vtbackup.md @@ -224,7 +224,7 @@ While it is running, `vtbackup` serves debugging info and metrics on port `15500 | --topo_zk_tls_ca | string | the server ca to use to validate servers when connecting to the zk topo server | | --topo_zk_tls_cert | string | the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS | | --topo_zk_tls_key | string | the key to use to connect to the zk topo server, enables TLS | -| --upgrade_safe | boolean | Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades | +| --upgrade-safe | boolean | Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades | | --v | Level | log level for V logs | | -v, --version | | print binary version | | --vmodule | moduleSpec | comma-separated list of pattern=N settings for file-filtered logging | diff --git a/content/en/docs/18.0/reference/programs/vtctl/_index.md b/content/en/docs/18.0/reference/programs/vtctl/_index.md index 718518d48..48d287653 100644 --- a/content/en/docs/18.0/reference/programs/vtctl/_index.md +++ b/content/en/docs/18.0/reference/programs/vtctl/_index.md @@ -32,7 +32,7 @@ Note that wherever `vtctl` commands produced master or MASTER for tablet type, t | [ExecuteFetchAsApp](../vtctl/tablets#executefetchasapp) | `ExecuteFetchAsApp -- [--max_rows=10000] [--json] [--use_pool] ` | | [ExecuteFetchAsDba](../vtctl/tablets#executefetchasdba) | `ExecuteFetchAsDba -- [--max_rows=10000] [--disable_binlogs] [--json] ` | | [VReplicationExec](../vtctl/tablets#vreplicationexec) | `VReplicationExec -- [--json] ` | -| [Backup](../vtctl/tablets#backup) | `Backup -- [--concurrency=4] [--allow_primary=false] [--upgrade_safe=false] ` | +| [Backup](../vtctl/tablets#backup) | `Backup -- [--concurrency=4] [--allow_primary=false] [--upgrade-safe=false] ` | | [RestoreFromBackup](../vtctl/tablets#restorefrombackup) | `RestoreFromBackup ` | | [ReparentTablet](../vtctl/tablets#reparenttablet) | `ReparentTablet ` | @@ -55,7 +55,7 @@ Note that wherever `vtctl` commands produced master or MASTER for tablet type, t | [RemoveShardCell](../vtctl/shards#removeshardcell) | `RemoveShardCell -- [--force] [--recursive] ` | | [DeleteShard](../vtctl/shards#deleteshard) | `DeleteShard -- [--recursive] [--even_if_serving] ...` | | [ListBackups](../vtctl/shards#listbackups) | `ListBackups ` | -| [BackupShard](../vtctl/shards#backupshard) | `BackupShard -- [--allow_primary=false] [--upgrade_safe=false] ` | +| [BackupShard](../vtctl/shards#backupshard) | `BackupShard -- [--allow_primary=false] [--upgrade-safe=false] ` | | [RemoveBackup](../vtctl/shards#removebackup) | `RemoveBackup ` | | (DEPRECATED) [InitShardPrimary](../vtctl/shards#initshardprimary) | `InitShardPrimary -- [--force] [--wait_replicas_timeout=] ` | | [PlannedReparentShard](../vtctl/shards#plannedreparentshard) | `PlannedReparentShard -- --keyspace_shard= [--new_primary=] [--avoid_tablet=] [--wait_replicas_timeout=]` | diff --git a/content/en/docs/18.0/reference/programs/vtctl/shards.md b/content/en/docs/18.0/reference/programs/vtctl/shards.md index ebd50204e..39c4833e5 100644 --- a/content/en/docs/18.0/reference/programs/vtctl/shards.md +++ b/content/en/docs/18.0/reference/programs/vtctl/shards.md @@ -325,7 +325,7 @@ Lists all the backups for a shard. ### BackupShard ``` -BackupShard -- [--allow_primary=false] [--upgrade_safe=false] +BackupShard -- [--allow_primary=false] [--upgrade-safe=false] ``` ### RemoveBackup diff --git a/content/en/docs/18.0/reference/programs/vtctl/tablets.md b/content/en/docs/18.0/reference/programs/vtctl/tablets.md index d47d29c66..915415109 100644 --- a/content/en/docs/18.0/reference/programs/vtctl/tablets.md +++ b/content/en/docs/18.0/reference/programs/vtctl/tablets.md @@ -382,14 +382,14 @@ Stops mysqld and uses the [BackupEngine](../../../../user-guides/operating-vites #### Example -
Backup -- [--concurrency=4] [--upgrade_safe=false] <tablet alias>
+
Backup -- [--concurrency=4] [--upgrade-safe=false] <tablet alias>
#### Flags | Name | Type | Definition | | :-------- | :--------- | :--------- | | concurrency | Int | Specifies the number of compression/checksum jobs to run simultaneously | -| upgrade_safe | Boolean | Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades | +| upgrade-safe | Boolean | Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades | #### Arguments diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md index 237b4b0ef..52127eb9d 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md @@ -23,13 +23,12 @@ For --sql, semi-colons and repeated values may be mixed, for example: ApplySchema --sql "CREATE TABLE my_table" --sql "CREATE TABLE my_other_table" ``` -vtctldclient ApplySchema [--allow-long-unavailability] [--ddl-strategy ] [--uuid ...] [--migration-context ] [--wait-replicas-timeout ] [--caller-id ] {--sql-file | --sql } +vtctldclient ApplySchema [--ddl-strategy ] [--uuid ...] [--migration-context ] [--wait-replicas-timeout ] [--caller-id ] {--sql-file | --sql } ``` ### Options ``` - --allow-long-unavailability Allow large schema changes which incur a longer unavailability of the database. --caller-id string Effective caller ID used for the operation and should map to an ACL name which grants this identity the necessary permissions to perform the operation (this is only necessary when strict table ACLs are used). --ddl-strategy string Online DDL strategy, compatible with @@ddl_strategy session variable (examples: 'gh-ost', 'pt-osc', 'gh-ost --max-load=Threads_running=100'. (default "direct") -h, --help help for ApplySchema diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Backup.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Backup.md index 9053049d3..3641bd1cb 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Backup.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Backup.md @@ -7,7 +7,7 @@ series: vtctldclient Uses the BackupStorage service on the given tablet to create and store a new backup. ``` -vtctldclient Backup [--concurrency ] [--allow-primary] [--upgrade_safe] +vtctldclient Backup [--concurrency ] [--allow-primary] [--upgrade-safe] ``` ### Options @@ -15,8 +15,8 @@ vtctldclient Backup [--concurrency ] [--allow-primary] [--upgrade_s ``` --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) - --upgrade_safe Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades. -h, --help help for Backup + --upgrade-safe Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades. ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md index 005ec5d1a..6a637c4b1 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md @@ -13,7 +13,7 @@ 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] [--upgrade_safe] +vtctldclient BackupShard [--concurrency ] [--allow-primary] [--upgrade-safe] ``` ### Options @@ -21,8 +21,8 @@ vtctldclient BackupShard [--concurrency ] [--allow-primary] [--upgr ``` --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) - --upgrade_safe Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades. -h, --help help for BackupShard + --upgrade-safe Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades. ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md index 7a2f22fc8..dc8e6974c 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md @@ -13,16 +13,16 @@ vtctldclient UpdateThrottlerConfig [--enable|--disable] [--threshold=] ### Options ``` - --check-as-check-self /throttler/check requests behave as is /throttler/check-self was called - --check-as-check-shard use standard behavior for /throttler/check requests - --custom-query string custom throttler check query - --disable Disable the throttler - --enable Enable the throttler - -h, --help help for UpdateThrottlerConfig - --threshold float threshold for the either default check (replication lag seconds) or custom check - --throttle-app string set a specific throttling rule for the given app - --throttle-app-ratio float set a throttling ratio for app indicated by --throttle-app. 0 means not throttled, 1.0 means fully throttled. - --throttle-app-duration duration time limit after which throttling rule expires. Set as 0 to cancel an existing rule + --check-as-check-self /throttler/check requests behave as is /throttler/check-self was called + --check-as-check-shard use standard behavior for /throttler/check requests + --custom-query string custom throttler check query + --disable Disable the throttler + --enable Enable the throttler + -h, --help help for UpdateThrottlerConfig + --threshold float threshold for the either default check (replication lag seconds) or custom check + --throttle-app string an app name to throttle + --throttle-app-duration duration duration after which throttled app rule expires (app specififed in --throttled-app) (default 1h0m0s) + --throttle-app-ratio float ratio to throttle app (app specififed in --throttled-app) (default 1) ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/user-guides/operating-vitess/backup-and-restore/creating-a-backup.md b/content/en/docs/18.0/user-guides/operating-vitess/backup-and-restore/creating-a-backup.md index 46188ffd0..6a5c7f4a6 100644 --- a/content/en/docs/18.0/user-guides/operating-vitess/backup-and-restore/creating-a-backup.md +++ b/content/en/docs/18.0/user-guides/operating-vitess/backup-and-restore/creating-a-backup.md @@ -86,7 +86,7 @@ To continue with risk: Set `--xtrabackup_backup_flags=--no-server-version-check` __Run the following vtctl command to create a backup:__ ```sh -vtctldclient --server=: Backup [--upgrade_safe=false] +vtctldclient --server=: Backup [--upgrade-safe=false] ``` If the engine is `builtin`, replication will be stopped prior to shutting down mysqld for the backup. @@ -96,7 +96,7 @@ If the engine is `xtrabackup`, the tablet can continue to serve traffic while th __Run the following vtctl command to backup a specific shard:__ ``` sh -vtctldclient --server=: BackupShard [--allow_primary=false] [--upgrade_safe=false] +vtctldclient --server=: BackupShard [--allow_primary=false] [--upgrade-safe=false] ``` ## Create an incremental backup with vtctl