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

Update docs for vtctldclient and flag name change #1542

Merged
merged 1 commit into from
Jul 20, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/vtbackup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vtctl/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] <tablet alias> <sql command>` |
| [ExecuteFetchAsDba](../vtctl/tablets#executefetchasdba) | `ExecuteFetchAsDba -- [--max_rows=10000] [--disable_binlogs] [--json] <tablet alias> <sql command>` |
| [VReplicationExec](../vtctl/tablets#vreplicationexec) | `VReplicationExec -- [--json] <tablet alias> <sql command>` |
| [Backup](../vtctl/tablets#backup) | `Backup -- [--concurrency=4] [--allow_primary=false] [--upgrade_safe=false] <tablet alias>` |
| [Backup](../vtctl/tablets#backup) | `Backup -- [--concurrency=4] [--allow_primary=false] [--upgrade-safe=false] <tablet alias>` |
| [RestoreFromBackup](../vtctl/tablets#restorefrombackup) | `RestoreFromBackup <tablet alias>` |
| [ReparentTablet](../vtctl/tablets#reparenttablet) | `ReparentTablet <tablet alias>` |

Expand All @@ -55,7 +55,7 @@ Note that wherever `vtctl` commands produced master or MASTER for tablet type, t
| [RemoveShardCell](../vtctl/shards#removeshardcell) | `RemoveShardCell -- [--force] [--recursive] <keyspace/shard> <cell>` |
| [DeleteShard](../vtctl/shards#deleteshard) | `DeleteShard -- [--recursive] [--even_if_serving] <keyspace/shard> ...` |
| [ListBackups](../vtctl/shards#listbackups) | `ListBackups <keyspace/shard>` |
| [BackupShard](../vtctl/shards#backupshard) | `BackupShard -- [--allow_primary=false] [--upgrade_safe=false] <keyspace/shard>` |
| [BackupShard](../vtctl/shards#backupshard) | `BackupShard -- [--allow_primary=false] [--upgrade-safe=false] <keyspace/shard>` |
| [RemoveBackup](../vtctl/shards#removebackup) | `RemoveBackup <keyspace/shard> <backup name>` |
| (DEPRECATED) [InitShardPrimary](../vtctl/shards#initshardprimary) | `InitShardPrimary -- [--force] [--wait_replicas_timeout=<duration>] <keyspace/shard> <tablet alias>` |
| [PlannedReparentShard](../vtctl/shards#plannedreparentshard) | `PlannedReparentShard -- --keyspace_shard=<keyspace/shard> [--new_primary=<tablet alias>] [--avoid_tablet=<tablet alias>] [--wait_replicas_timeout=<duration>]` |
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/vtctl/shards.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ Lists all the backups for a shard.
### BackupShard

```
BackupShard -- [--allow_primary=false] [--upgrade_safe=false] <keyspace/shard>
BackupShard -- [--allow_primary=false] [--upgrade-safe=false] <keyspace/shard>
```

### RemoveBackup
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/18.0/reference/programs/vtctl/tablets.md
Original file line number Diff line number Diff line change
Expand Up @@ -382,14 +382,14 @@ Stops mysqld and uses the [BackupEngine](../../../../user-guides/operating-vites

#### Example

<pre class="command-example">Backup -- [--concurrency=4] [--upgrade_safe=false] &lt;tablet alias&gt;</pre>
<pre class="command-example">Backup -- [--concurrency=4] [--upgrade-safe=false] &lt;tablet alias&gt;</pre>

#### Flags

| Name | Type | Definition |
| :-------- | :--------- | :--------- |
| concurrency | Int | Specifies the number of compression/checksum jobs to run simultaneously |
| upgrade_safe | Boolean | Whether to use <code>innodb_fast_shutdown=0</code> for the backup so it is safe to use for MySQL upgrades |
| upgrade-safe | Boolean | Whether to use <code>innodb_fast_shutdown=0</code> for the backup so it is safe to use for MySQL upgrades |

#### Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <strategy>] [--uuid <uuid> ...] [--migration-context <context>] [--wait-replicas-timeout <duration>] [--caller-id <caller_id>] {--sql-file <file> | --sql <sql>} <keyspace>
vtctldclient ApplySchema [--ddl-strategy <strategy>] [--uuid <uuid> ...] [--migration-context <context>] [--wait-replicas-timeout <duration>] [--caller-id <caller_id>] {--sql-file <file> | --sql <sql>} <keyspace>
```

### 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ series: vtctldclient
Uses the BackupStorage service on the given tablet to create and store a new backup.

```
vtctldclient Backup [--concurrency <concurrency>] [--allow-primary] [--upgrade_safe] <tablet_alias>
vtctldclient Backup [--concurrency <concurrency>] [--allow-primary] [--upgrade-safe] <tablet_alias>
```

### Options

```
--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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ 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 <concurrency>] [--allow-primary] [--upgrade_safe] <keyspace/shard>
vtctldclient BackupShard [--concurrency <concurrency>] [--allow-primary] [--upgrade-safe] <keyspace/shard>
```

### Options

```
--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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ vtctldclient UpdateThrottlerConfig [--enable|--disable] [--threshold=<float64>]
### 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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=<vtctld_host>:<vtctld_port> Backup [--upgrade_safe=false] <tablet-alias>
vtctldclient --server=<vtctld_host>:<vtctld_port> Backup [--upgrade-safe=false] <tablet-alias>
```

If the engine is `builtin`, replication will be stopped prior to shutting down mysqld for the backup.
Expand All @@ -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=<vtctld_host>:<vtctld_port> BackupShard [--allow_primary=false] [--upgrade_safe=false] <keyspace/shard>
vtctldclient --server=<vtctld_host>:<vtctld_port> BackupShard [--allow_primary=false] [--upgrade-safe=false] <keyspace/shard>
```

## Create an incremental backup with vtctl
Expand Down