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

[cobradocs] synchronize with Correctly set log_dir default in vtcombo (vitess#15153) #1679

Closed
wants to merge 1 commit into from
Closed
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: workflow
series: vtctldclient
commit: 9a3628037518bc108c636220319f3c7385b2a559
---
## vtctldclient workflow

Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace

```
vtctldclient workflow
```

### Options

```
-h, --help help for workflow
-k, --keyspace string Keyspace context for the workflow (required)
```

### Options inherited from parent commands

```
--action_timeout duration timeout for the total command (default 1h0m0s)
--server string server to use for connection (required)
```

### SEE ALSO

* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server.
* [vtctldclient workflow update](./vtctldclient_workflow_update/) - Update the configuration parameters for a VReplication workflow

Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: workflow update
series: vtctldclient
commit: 9a3628037518bc108c636220319f3c7385b2a559
---
## vtctldclient workflow update

Update the configuration parameters for a VReplication workflow

```
vtctldclient workflow update
```

### Examples

```
vtctldclient --server=localhost:15999 workflow --keyspace=customer update --workflow=commerce2customer --cells "zone1" --cells "zone2" -c "zone3,zone4" -c "zone5"
```

### Options

```
-c, --cells strings New Cell(s) or CellAlias(es) (comma-separated) to replicate from
-h, --help help for update
--on-ddl string New instruction on what to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE
-t, --tablet-types strings New source tablet types to replicate from (e.g. PRIMARY,REPLICA,RDONLY)
-w, --workflow string The workflow you want to update (required)
```

### Options inherited from parent commands

```
--action_timeout duration timeout for the total command (default 1h0m0s)
-k, --keyspace string Keyspace context for the workflow (required)
--server string server to use for connection (required)
```

### SEE ALSO

* [vtctldclient workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: init
series: mysqlctl
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## mysqlctl init

Expand Down Expand Up @@ -44,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 [<WORKDIR>])
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/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,7 +1,7 @@
---
title: init config
series: mysqlctl
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## mysqlctl init_config

Expand Down Expand Up @@ -42,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 [<WORKDIR>])
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/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,7 +1,7 @@
---
title: position
series: mysqlctl
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## mysqlctl position

Expand All @@ -27,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 [<WORKDIR>])
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/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,7 +1,7 @@
---
title: reinit config
series: mysqlctl
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## mysqlctl reinit_config

Expand Down Expand Up @@ -42,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 [<WORKDIR>])
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/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,7 +1,7 @@
---
title: shutdown
series: mysqlctl
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## mysqlctl shutdown

Expand Down Expand Up @@ -40,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 [<WORKDIR>])
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/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,7 +1,7 @@
---
title: start
series: mysqlctl
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## mysqlctl start

Expand Down Expand Up @@ -39,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 [<WORKDIR>])
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/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,7 +1,7 @@
---
title: teardown
series: mysqlctl
commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## mysqlctl teardown

Expand Down Expand Up @@ -43,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 [<WORKDIR>])
--config-path strings Paths to search for config files in. (default [/tmp/pull_request_handler/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
@@ -0,0 +1,33 @@
---
title: LookupVindex
series: vtctldclient
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## vtctldclient LookupVindex

Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows.

### Options

```
-h, --help help for LookupVindex
--name string The name of the Lookup Vindex to create. This will also be the name of the VReplication workflow created to backfill the Lookup Vindex.
--table-keyspace string The keyspace to create the lookup table in. This is also where the VReplication workflow is created to backfill the Lookup Vindex.
```

### Options inherited from parent commands

```
--action_timeout duration timeout to use for the command (default 1h0m0s)
--compact use compact format for otherwise verbose outputs
--server string server to use for the connection (required)
```

### SEE ALSO

* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server.
* [vtctldclient LookupVindex cancel](./vtctldclient_lookupvindex_cancel/) - Cancel the VReplication workflow that backfills the Lookup Vindex.
* [vtctldclient LookupVindex create](./vtctldclient_lookupvindex_create/) - Create the Lookup Vindex in the specified keyspace and backfill it with a VReplication workflow.
* [vtctldclient LookupVindex externalize](./vtctldclient_lookupvindex_externalize/) - Externalize the Lookup Vindex. If the Vindex has an owner the VReplication workflow will also be deleted.
* [vtctldclient LookupVindex show](./vtctldclient_lookupvindex_show/) - Show the status of the VReplication workflow that backfills the Lookup Vindex.

Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: LookupVindex cancel
series: vtctldclient
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## vtctldclient LookupVindex cancel

Cancel the VReplication workflow that backfills the Lookup Vindex.

```
vtctldclient LookupVindex cancel
```

### Examples

```
vtctldclient --server localhost:15999 LookupVindex --name corder_lookup_vdx --table-keyspace customer cancel
```

### Options

```
-h, --help help for cancel
```

### Options inherited from parent commands

```
--action_timeout duration timeout to use for the command (default 1h0m0s)
--compact use compact format for otherwise verbose outputs
--name string The name of the Lookup Vindex to create. This will also be the name of the VReplication workflow created to backfill the Lookup Vindex.
--server string server to use for the connection (required)
--table-keyspace string The keyspace to create the lookup table in. This is also where the VReplication workflow is created to backfill the Lookup Vindex.
```

### SEE ALSO

* [vtctldclient LookupVindex](./vtctldclient_lookupvindex/) - Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows.

Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: LookupVindex create
series: vtctldclient
commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff
---
## vtctldclient LookupVindex create

Create the Lookup Vindex in the specified keyspace and backfill it with a VReplication workflow.

```
vtctldclient LookupVindex create
```

### Examples

```
vtctldclient --server localhost:15999 LookupVindex --name corder_lookup_vdx --table-keyspace customer create --keyspace customer --type consistent_lookup_unique --table-owner corder --table-owner-columns sku --table-name corder_lookup_tbl --table-vindex-type unicode_loose_xxhash
```

### Options

```
--cells strings Cells to look in for source tablets to replicate from.
--continue-after-copy-with-owner Vindex will continue materialization after the backfill completes when an owner is provided. (default true)
-h, --help help for create
--ignore-nulls Do not add corresponding records in the lookup table if any of the owner table's 'from' fields are NULL.
--keyspace string The keyspace to create the Lookup Vindex in. This is also where the table-owner must exist.
--table-name string The name of the lookup table. If not specified, then it will be created using the same name as the Lookup Vindex.
--table-owner string The table holding the data which we should use to backfill the Lookup Vindex. This must exist in the same keyspace as the Lookup Vindex.
--table-owner-columns strings The columns to read from the owner table. These will be used to build the hash which gets stored as the keyspace_id value in the lookup table.
--table-vindex-type string The primary vindex name/type to use for the lookup table, if the table-keyspace is sharded. This must match the name of a vindex defined in the table-keyspace. If no value is provided then the default type will be used based on the table-owner-columns types.
--tablet-types strings Source tablet types to replicate from.
--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)
--type string The type of Lookup Vindex to create.
```

### Options inherited from parent commands

```
--action_timeout duration timeout to use for the command (default 1h0m0s)
--compact use compact format for otherwise verbose outputs
--name string The name of the Lookup Vindex to create. This will also be the name of the VReplication workflow created to backfill the Lookup Vindex.
--server string server to use for the connection (required)
--table-keyspace string The keyspace to create the lookup table in. This is also where the VReplication workflow is created to backfill the Lookup Vindex.
```

### SEE ALSO

* [vtctldclient LookupVindex](./vtctldclient_lookupvindex/) - Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows.

Loading