diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/_index.md b/content/en/docs/19.0/reference/programs/mysqlctl/_index.md index 220d89b20..095497b6a 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/_index.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/_index.md @@ -1,7 +1,7 @@ --- title: mysqlctl series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## mysqlctl @@ -80,6 +80,7 @@ This helps ensure that `mysqld` is automatically restarted after failures. --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init.md index 60bb965ad..60345d5b6 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init.md @@ -1,7 +1,7 @@ --- title: init series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## mysqlctl init @@ -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 []) + --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 @@ -98,6 +98,7 @@ mysqlctl \ --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init_config.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init_config.md index 1d51bccc5..054e0654b 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init_config.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init_config.md @@ -1,7 +1,7 @@ --- title: init config series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## mysqlctl init_config @@ -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 []) + --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 @@ -96,6 +96,7 @@ mysqlctl \ --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_position.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_position.md index 533781f90..0fd743331 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_position.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_position.md @@ -1,7 +1,7 @@ --- title: position series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## mysqlctl position @@ -27,7 +27,7 @@ mysqlctl position [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 []) + --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 @@ -81,6 +81,7 @@ mysqlctl position [flags] --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md index 34d756268..086268c57 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md @@ -1,7 +1,7 @@ --- title: reinit config series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## mysqlctl reinit_config @@ -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 []) + --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 @@ -96,6 +96,7 @@ mysqlctl \ --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_shutdown.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_shutdown.md index 4f6cec9ed..0e85514ee 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_shutdown.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_shutdown.md @@ -1,7 +1,7 @@ --- title: shutdown series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## mysqlctl shutdown @@ -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 []) + --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 @@ -94,6 +94,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr shutdown --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_start.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_start.md index 69d80819c..b9d59e373 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_start.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_start.md @@ -1,7 +1,7 @@ --- title: start series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## mysqlctl start @@ -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 []) + --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 @@ -93,6 +93,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr start --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_teardown.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_teardown.md index 9ea036d59..c2165da74 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_teardown.md +++ b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_teardown.md @@ -1,7 +1,7 @@ --- title: teardown series: mysqlctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## mysqlctl teardown @@ -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 []) + --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 @@ -97,6 +97,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr teardown --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) diff --git a/content/en/docs/19.0/reference/programs/mysqlctld/_index.md b/content/en/docs/19.0/reference/programs/mysqlctld/_index.md index be3ce512d..5cf2e34b1 100644 --- a/content/en/docs/19.0/reference/programs/mysqlctld/_index.md +++ b/content/en/docs/19.0/reference/programs/mysqlctld/_index.md @@ -1,7 +1,7 @@ --- title: mysqlctld series: mysqlctld -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## mysqlctld @@ -123,6 +123,7 @@ mysqlctld \ --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --port int port for the server --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) diff --git a/content/en/docs/19.0/reference/programs/topo2topo/_index.md b/content/en/docs/19.0/reference/programs/topo2topo/_index.md index 98cda6967..c586639e1 100644 --- a/content/en/docs/19.0/reference/programs/topo2topo/_index.md +++ b/content/en/docs/19.0/reference/programs/topo2topo/_index.md @@ -1,7 +1,7 @@ --- title: topo2topo series: topo2topo -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## topo2topo @@ -47,6 +47,7 @@ topo2topo [flags] --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) --logtostderr log to standard error instead of files --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) --stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1) diff --git a/content/en/docs/19.0/reference/programs/vtaclcheck/_index.md b/content/en/docs/19.0/reference/programs/vtaclcheck/_index.md index 6f5619789..4d1b9e9bb 100644 --- a/content/en/docs/19.0/reference/programs/vtaclcheck/_index.md +++ b/content/en/docs/19.0/reference/programs/vtaclcheck/_index.md @@ -1,7 +1,7 @@ --- title: vtaclcheck series: vtaclcheck -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vtaclcheck @@ -31,6 +31,7 @@ vtaclcheck [flags] --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) --logtostderr log to standard error instead of files --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) --static-auth-file string The path of the auth_server_static JSON file to check diff --git a/content/en/docs/19.0/reference/programs/vtbackup/_index.md b/content/en/docs/19.0/reference/programs/vtbackup/_index.md index b0d55e727..4c5661878 100644 --- a/content/en/docs/19.0/reference/programs/vtbackup/_index.md +++ b/content/en/docs/19.0/reference/programs/vtbackup/_index.md @@ -1,7 +1,7 @@ --- title: vtbackup series: vtbackup -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vtbackup @@ -196,6 +196,7 @@ vtbackup [flags] --opentsdb_uri string URI of opentsdb /api/put method --port int port for the server --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --remote_operation_timeout duration time to wait for a remote operation (default 15s) --restart_before_backup Perform a mysqld clean/full restart after applying binlogs, but before taking the backup. Only makes sense to work around xtrabackup bugs. @@ -219,7 +220,7 @@ vtbackup [flags] --stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1) --tablet_manager_grpc_ca string the server ca to use to validate servers when connecting --tablet_manager_grpc_cert string the cert to use to connect - --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8) + --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8) --tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100) --tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting --tablet_manager_grpc_key string the key to use to connect diff --git a/content/en/docs/19.0/reference/programs/vtclient/_index.md b/content/en/docs/19.0/reference/programs/vtclient/_index.md index 6dd4d0e11..4eb85128a 100644 --- a/content/en/docs/19.0/reference/programs/vtclient/_index.md +++ b/content/en/docs/19.0/reference/programs/vtclient/_index.md @@ -1,7 +1,7 @@ --- title: vtclient series: vtclient -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vtclient @@ -55,6 +55,7 @@ vtclient --server vtgate:15991 --target '@primary' --bind_variables '[ 12345, 1, --mysql_server_version string MySQL server version to advertise. (default "8.0.30-Vitess") --parallel int DMLs only: Number of threads executing the same query in parallel. Useful for simple load testing. (default 1) --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --qps int queries per second to throttle each thread at. --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) diff --git a/content/en/docs/19.0/reference/programs/vtcombo/_index.md b/content/en/docs/19.0/reference/programs/vtcombo/_index.md index 1f8e92a41..0ea6b5fd5 100644 --- a/content/en/docs/19.0/reference/programs/vtcombo/_index.md +++ b/content/en/docs/19.0/reference/programs/vtcombo/_index.md @@ -1,7 +1,7 @@ --- title: vtcombo series: vtcombo -commit: 6b481a7dc8639a070f8aa42773aa9c5a497f79c7 +commit: 43ef6ae99f08fc573b00474e555af693911fee79 --- ## vtcombo @@ -179,6 +179,7 @@ vtcombo [flags] --grpc_server_keepalive_enforcement_policy_permit_without_stream gRPC server permit client keepalive pings even when there are no active streams (RPCs) --grpc_use_effective_callerid If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal. --health_check_interval duration Interval between health checks (default 20s) + --healthcheck-init-concurrency int Concurrency of intiating healthchecks. This should be less than the golang max thread limit of 10000. (default 1024) --healthcheck_retry_delay duration health check retry delay (default 2ms) --healthcheck_timeout duration the health check timeout period (default 1m0s) --heartbeat_enable If true, vttablet records (if master) or checks (if replica) the current time of a replication heartbeat in the sidecar database's heartbeat table. The result is used to inform the serving state of the vttablet via healthchecks. @@ -270,6 +271,7 @@ vtcombo [flags] --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --port int port for the server --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --proto_topo vttest.TopoData vttest proto definition of the topology, encoded in compact text format. See vttest.proto for more information. --proxy_protocol Enable HAProxy PROXY protocol on MySQL listener socket --proxy_tablets Setting this true will make vtctld proxy the tablet status instead of redirecting to them @@ -356,7 +358,7 @@ vtcombo [flags] --tablet_hostname string if not empty, this hostname will be assumed instead of trying to resolve it --tablet_manager_grpc_ca string the server ca to use to validate servers when connecting --tablet_manager_grpc_cert string the cert to use to connect - --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8) + --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8) --tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100) --tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting --tablet_manager_grpc_key string the key to use to connect diff --git a/content/en/docs/19.0/reference/programs/vtctld/_index.md b/content/en/docs/19.0/reference/programs/vtctld/_index.md index c785bafde..7dda96737 100644 --- a/content/en/docs/19.0/reference/programs/vtctld/_index.md +++ b/content/en/docs/19.0/reference/programs/vtctld/_index.md @@ -1,7 +1,7 @@ --- title: vtctld series: vtctld -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 43ef6ae99f08fc573b00474e555af693911fee79 --- ## vtctld @@ -99,6 +99,7 @@ vtctld \ --grpc_server_initial_window_size int gRPC server initial window size --grpc_server_keepalive_enforcement_policy_min_time duration gRPC server minimum keepalive time (default 10s) --grpc_server_keepalive_enforcement_policy_permit_without_stream gRPC server permit client keepalive pings even when there are no active streams (RPCs) + --healthcheck-init-concurrency int Concurrency of intiating healthchecks. This should be less than the golang max thread limit of 10000. (default 1024) -h, --help help for vtctld --jaeger-agent-host string host and port to send spans to. if empty, no tracing will be done --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) @@ -111,12 +112,14 @@ vtctld \ --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) --logtostderr log to standard error instead of files --max-stack-size int configure the maximum stack size in bytes (default 67108864) + --mysql_server_version string MySQL server version to advertise. (default "8.0.30-Vitess") --onclose_timeout duration wait no more than this for OnClose handlers before stopping (default 10s) --onterm_timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s) --opentsdb_uri string URI of opentsdb /api/put method --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. --port int port for the server --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --proxy_tablets Setting this true will make vtctld proxy the tablet status instead of redirecting to them --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --remote_operation_timeout duration time to wait for a remote operation (default 15s) @@ -154,7 +157,7 @@ vtctld \ --tablet_health_keep_alive duration close streaming tablet health connection if there are no requests for this long (default 5m0s) --tablet_manager_grpc_ca string the server ca to use to validate servers when connecting --tablet_manager_grpc_cert string the cert to use to connect - --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8) + --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8) --tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100) --tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting --tablet_manager_grpc_key string the key to use to connect diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md index 64903834d..e8fe7f939 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md @@ -1,14 +1,14 @@ --- title: ApplyVSchema series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vtctldclient ApplyVSchema Applies the VTGate routing schema to the provided keyspace. Shows the result after application. ``` -vtctldclient ApplyVSchema {--vschema= || --vschema-file= || --sql= || --sql-file=} [--cells=c1,c2,...] [--skip-rebuild] [--dry-run] +vtctldclient ApplyVSchema {--vschema= || --vschema-file= || --sql= || --sql-file=} [--cells=c1,c2,...] [--skip-rebuild] [--dry-run] [--strict] ``` ### Options @@ -20,6 +20,7 @@ vtctldclient ApplyVSchema {--vschema= || --vschema-file= --skip-rebuild Skip rebuilding the SrvSchema objects. --sql alter table t add vindex hash(id) A VSchema DDL SQL statement, e.g. alter table t add vindex hash(id). --sql-file string Path to a file containing a VSchema DDL SQL. + --strict If set, treat unknown vindex params as errors. --vschema string VSchema to apply, in JSON form. --vschema-file string Path to a file containing the vschema to apply, in JSON form. ``` diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Backup.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Backup.md index 4772e1066..3165dee29 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Backup.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Backup.md @@ -1,7 +1,7 @@ --- title: Backup series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vtctldclient Backup @@ -15,7 +15,7 @@ vtctldclient Backup [--concurrency ] [--allow-primary] [--increment ``` --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) + --concurrency int32 Specifies the number of compression/checksum jobs to run simultaneously. (default 4) -h, --help help for Backup --incremental-from-pos string Position of previous backup. Default: empty. If given, then this backup becomes an incremental backup from given position. If value is 'auto', backup taken from last successful backup position --upgrade-safe Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades. diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md index 4bd63ab39..b11338e01 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md @@ -1,7 +1,7 @@ --- title: BackupShard series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vtctldclient BackupShard @@ -21,7 +21,7 @@ vtctldclient BackupShard [--concurrency ] [--allow-primary] [--incr ``` --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) + --concurrency int32 Specifies the number of compression/checksum jobs to run simultaneously. (default 4) -h, --help help for BackupShard --incremental-from-pos string Position of previous backup. Default: empty. If given, then this backup becomes an incremental backup from given position. If value is 'auto', backup taken from last successful backup position --upgrade-safe Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades. diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md new file mode 100644 index 000000000..d2af4d8e2 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md @@ -0,0 +1,36 @@ +--- +title: LookupVindex +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### 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. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_cancel.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_cancel.md new file mode 100644 index 000000000..04a420174 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_cancel.md @@ -0,0 +1,42 @@ +--- +title: LookupVindex cancel +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## 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. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient LookupVindex](./vtctldclient_lookupvindex/) - Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_create.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_create.md new file mode 100644 index 000000000..edccd918c --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_create.md @@ -0,0 +1,53 @@ +--- +title: LookupVindex create +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## 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. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient LookupVindex](./vtctldclient_lookupvindex/) - Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_externalize.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_externalize.md new file mode 100644 index 000000000..fbbc4885e --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_externalize.md @@ -0,0 +1,43 @@ +--- +title: LookupVindex externalize +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient LookupVindex externalize + +Externalize the Lookup Vindex. If the Vindex has an owner the VReplication workflow will also be deleted. + +``` +vtctldclient LookupVindex externalize +``` + +### Examples + +``` +vtctldclient --server localhost:15999 LookupVindex --name corder_lookup_vdx --table-keyspace customer externalize +``` + +### Options + +``` + -h, --help help for externalize + --keyspace string The keyspace containing the Lookup Vindex. If no value is specified then the table-keyspace will be used. +``` + +### 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. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient LookupVindex](./vtctldclient_lookupvindex/) - Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_show.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_show.md new file mode 100644 index 000000000..6a06e7544 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_show.md @@ -0,0 +1,42 @@ +--- +title: LookupVindex show +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient LookupVindex show + +Show the status of the VReplication workflow that backfills the Lookup Vindex. + +``` +vtctldclient LookupVindex show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 LookupVindex --name corder_lookup_vdx --table-keyspace customer show +``` + +### Options + +``` + -h, --help help for show +``` + +### 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. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient LookupVindex](./vtctldclient_lookupvindex/) - Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize.md new file mode 100644 index 000000000..b14dcfe5e --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize.md @@ -0,0 +1,38 @@ +--- +title: Materialize +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Materialize + +Perform commands related to materializing query results from the source keyspace into tables in the target keyspace. + +### Options + +``` + --format string The format of the output; supported formats are: text,json. (default "text") + -h, --help help for Materialize + --target-keyspace string Target keyspace for this workflow. + -w, --workflow string The workflow you want to perform the command on. +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient Materialize cancel](./vtctldclient_materialize_cancel/) - Cancel a Materialize VReplication workflow. +* [vtctldclient Materialize create](./vtctldclient_materialize_create/) - Create and run a Materialize VReplication workflow. +* [vtctldclient Materialize show](./vtctldclient_materialize_show/) - Show the details for a Materialize VReplication workflow. +* [vtctldclient Materialize start](./vtctldclient_materialize_start/) - Start a Materialize workflow. +* [vtctldclient Materialize stop](./vtctldclient_materialize_stop/) - Stop a Materialize workflow. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_cancel.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_cancel.md new file mode 100644 index 000000000..2546aba30 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_cancel.md @@ -0,0 +1,43 @@ +--- +title: Materialize cancel +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Materialize cancel + +Cancel a Materialize VReplication workflow. + +``` +vtctldclient Materialize cancel +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Materialize --workflow product_sales --target-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 + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Materialize](./vtctldclient_materialize/) - Perform commands related to materializing query results from the source keyspace into tables in the target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_create.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_create.md new file mode 100644 index 000000000..252672d8c --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_create.md @@ -0,0 +1,82 @@ +--- +title: Materialize create +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Materialize create + +Create and run a Materialize VReplication workflow. + +### Synopsis + +Materialize is a lower level VReplication command that allows for generalized materialization +of tables. The target tables can be copies, aggregations, or views. The target tables are kept +in sync in near-realtime. The primary flag used to define the materializations (you can have +multiple per workflow) is table-settings which is a JSON array where each value must contain +two key/value pairs. The first required key is 'target_table' and it is the name of the table +in the target-keyspace to store the results in. The second required key is 'source_expression' +and its value is the select query to run against the source table. An optional key/value pair +can also be specified for 'create_ddl' which provides the DDL to create the target table if it +does not exist -- you can alternatively specify a value of 'copy' if the target table schema +should be copied as-is from the source keyspace. Here's an example value for table-settings: +[ + { + "target_table": "customer_one_email", + "source_expression": "select email from customer where customer_id = 1" + }, + { + "target_table": "states", + "source_expression": "select * from states", + "create_ddl": "copy" + }, + { + "target_table": "sales_by_sku", + "source_expression": "select sku, count(*) as orders, sum(price) as revenue from corder group by sku", + "create_ddl": "create table sales_by_sku (sku varbinary(128) not null primary key, orders bigint, revenue bigint)" + } +] + + +``` +vtctldclient Materialize create +``` + +### Examples + +``` +vtctldclient --server localhost:15999 materialize --workflow product_sales --target-keyspace commerce create --source-keyspace commerce --table-settings '[{"target_table": "sales_by_sku", "create_ddl": "create table sales_by_sku (sku varbinary(128) not null primary key, orders bigint, revenue bigint)", "source_expression": "select sku, count(*) as orders, sum(price) as revenue from corder group by sku"}]' --cells zone1 --cells zone2 --tablet-types replica +``` + +### Options + +``` + -c, --cells strings Cells and/or CellAliases to copy table data from. + -h, --help help for create + --mysql_server_version string Configure the MySQL version to use for example for the parser. (default "8.0.30-Vitess") + --source-keyspace string Keyspace where the tables queried in the 'source_expression' values within table-settings live. + --sql-max-length-errors int truncate queries in error logs to the given length (default unlimited) + --sql-max-length-ui int truncate queries in debug UIs to the given length (default 512) (default 512) + --stop-after-copy Stop the workflow after it's finished copying the existing rows and before it starts replicating changes. + --table-settings JSON A JSON array defining what tables to materialize using what select statements. See the --help output for more details. (default null) + --tablet-types strings Source tablet types to replicate table data from (e.g. PRIMARY,REPLICA,RDONLY). + --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) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Materialize](./vtctldclient_materialize/) - Perform commands related to materializing query results from the source keyspace into tables in the target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_show.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_show.md new file mode 100644 index 000000000..5a008a452 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_show.md @@ -0,0 +1,44 @@ +--- +title: Materialize show +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Materialize show + +Show the details for a Materialize VReplication workflow. + +``` +vtctldclient Materialize show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Materialize --workflow product_sales --target-keyspace customer show +``` + +### Options + +``` + -h, --help help for show + --include-logs Include recent logs for the workflow. (default true) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Materialize](./vtctldclient_materialize/) - Perform commands related to materializing query results from the source keyspace into tables in the target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_start.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_start.md new file mode 100644 index 000000000..8e46f8d49 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_start.md @@ -0,0 +1,43 @@ +--- +title: Materialize start +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Materialize start + +Start a Materialize workflow. + +``` +vtctldclient Materialize start +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Materialize --workflow product_sales --target-keyspace customer start +``` + +### Options + +``` + -h, --help help for start +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Materialize](./vtctldclient_materialize/) - Perform commands related to materializing query results from the source keyspace into tables in the target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_stop.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_stop.md new file mode 100644 index 000000000..5d39ab2c1 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_stop.md @@ -0,0 +1,43 @@ +--- +title: Materialize stop +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Materialize stop + +Stop a Materialize workflow. + +``` +vtctldclient Materialize stop +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Materialize --workflow product_sales --target-keyspace customer stop +``` + +### Options + +``` + -h, --help help for stop +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Materialize](./vtctldclient_materialize/) - Perform commands related to materializing query results from the source keyspace into tables in the target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate.md new file mode 100644 index 000000000..6a515b2de --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate.md @@ -0,0 +1,38 @@ +--- +title: Migrate +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Migrate + +Migrate is used to import data from an external cluster into the current cluster. + +### Options + +``` + --format string The format of the output; supported formats are: text,json. (default "text") + -h, --help help for Migrate + --target-keyspace string Target keyspace for this workflow. + -w, --workflow string The workflow you want to perform the command on. +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient Migrate cancel](./vtctldclient_migrate_cancel/) - Cancel a Migrate VReplication workflow. +* [vtctldclient Migrate complete](./vtctldclient_migrate_complete/) - Complete a Migrate VReplication workflow. +* [vtctldclient Migrate create](./vtctldclient_migrate_create/) - Create and optionally run a Migrate VReplication workflow. +* [vtctldclient Migrate show](./vtctldclient_migrate_show/) - Show the details for a Migrate VReplication workflow. +* [vtctldclient Migrate status](./vtctldclient_migrate_status/) - Show the current status for a Migrate VReplication workflow. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_cancel.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_cancel.md new file mode 100644 index 000000000..93156b674 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_cancel.md @@ -0,0 +1,43 @@ +--- +title: Migrate cancel +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Migrate cancel + +Cancel a Migrate VReplication workflow. + +``` +vtctldclient Migrate cancel +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Migrate --workflow import --target-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 + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Migrate](./vtctldclient_migrate/) - Migrate is used to import data from an external cluster into the current cluster. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_complete.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_complete.md new file mode 100644 index 000000000..25b1eabde --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_complete.md @@ -0,0 +1,43 @@ +--- +title: Migrate complete +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Migrate complete + +Complete a Migrate VReplication workflow. + +``` +vtctldclient Migrate complete +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Migrate --workflow import --target-keyspace customer complete +``` + +### Options + +``` + -h, --help help for complete +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Migrate](./vtctldclient_migrate/) - Migrate is used to import data from an external cluster into the current cluster. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_create.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_create.md new file mode 100644 index 000000000..fcf5f43db --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_create.md @@ -0,0 +1,58 @@ +--- +title: Migrate create +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Migrate create + +Create and optionally run a Migrate VReplication workflow. + +``` +vtctldclient Migrate create +``` + +### Examples + +``` +vtctldclient --server localhost:15999 migrate --workflow import --target-keyspace customer create --source-keyspace commerce --mount-name ext1 --tablet-types replica +``` + +### Options + +``` + -a, --all-cells Copy table data from any existing cell. + --all-tables Copy all tables from the source. + --auto-start Start the workflow after creating it. (default true) + -c, --cells strings Cells and/or CellAliases to copy table data from. + --defer-secondary-keys Defer secondary index creation for a table until after it has been copied. + --exclude-tables strings Source tables to exclude from copying. + -h, --help help for create + --mount-name string Name external cluster is mounted as. + --no-routing-rules (Advanced) Do not create routing rules while creating the workflow. See the reference documentation for limitations if you use this flag. + --on-ddl string What to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE. (default "IGNORE") + --source-keyspace string Keyspace where the tables are being moved from. + --source-time-zone string Specifying this causes any DATETIME fields to be converted from the given time zone into UTC. + --stop-after-copy Stop the workflow after it's finished copying the existing rows and before it starts replicating changes. + --tables strings Source tables to copy. + --tablet-types strings Source tablet types to replicate table data from (e.g. PRIMARY,REPLICA,RDONLY). + --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) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Migrate](./vtctldclient_migrate/) - Migrate is used to import data from an external cluster into the current cluster. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_show.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_show.md new file mode 100644 index 000000000..85a23f9d7 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_show.md @@ -0,0 +1,44 @@ +--- +title: Migrate show +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Migrate show + +Show the details for a Migrate VReplication workflow. + +``` +vtctldclient Migrate show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Migrate --workflow import --target-keyspace customer show +``` + +### Options + +``` + -h, --help help for show + --include-logs Include recent logs for the workflow. (default true) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Migrate](./vtctldclient_migrate/) - Migrate is used to import data from an external cluster into the current cluster. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_status.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_status.md new file mode 100644 index 000000000..909d2baa0 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_status.md @@ -0,0 +1,43 @@ +--- +title: Migrate status +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Migrate status + +Show the current status for a Migrate VReplication workflow. + +``` +vtctldclient Migrate status +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Migrate --workflow import --target-keyspace customer status +``` + +### Options + +``` + -h, --help help for status +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Migrate](./vtctldclient_migrate/) - Migrate is used to import data from an external cluster into the current cluster. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount.md new file mode 100644 index 000000000..bc9fb8e88 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount.md @@ -0,0 +1,34 @@ +--- +title: Mount +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Mount + +Mount is used to link an external Vitess cluster in order to migrate data from it. + +### Options + +``` + -h, --help help for Mount +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient Mount list](./vtctldclient_mount_list/) - List all mounted external Vitess Clusters. +* [vtctldclient Mount register](./vtctldclient_mount_register/) - Register an external Vitess Cluster. +* [vtctldclient Mount show](./vtctldclient_mount_show/) - Show attributes of a previously mounted external Vitess Cluster. +* [vtctldclient Mount unregister](./vtctldclient_mount_unregister/) - Unregister a previously mounted external Vitess Cluster. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_list.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_list.md new file mode 100644 index 000000000..d34bb8f19 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_list.md @@ -0,0 +1,40 @@ +--- +title: Mount list +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Mount list + +List all mounted external Vitess Clusters. + +``` +vtctldclient Mount list +``` + +### Examples + +``` +vtctldclient --server localhost:15999 mount list +``` + +### Options + +``` + -h, --help help for list +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient Mount](./vtctldclient_mount/) - Mount is used to link an external Vitess cluster in order to migrate data from it. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_register.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_register.md new file mode 100644 index 000000000..a256e2a9f --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_register.md @@ -0,0 +1,44 @@ +--- +title: Mount register +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Mount register + +Register an external Vitess Cluster. + +``` +vtctldclient Mount register +``` + +### Examples + +``` +vtctldclient --server localhost:15999 mount register --name ext1 --topo-type etcd2 --topo-server localhost:12379 --topo-root /vitess/global +``` + +### Options + +``` + -h, --help help for register + --name string Name to use for the mount. + --topo-root string Topo server root path. + --topo-server string Topo server address. + --topo-type string Topo server implementation to use. +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient Mount](./vtctldclient_mount/) - Mount is used to link an external Vitess cluster in order to migrate data from it. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_show.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_show.md new file mode 100644 index 000000000..5086ea14a --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_show.md @@ -0,0 +1,41 @@ +--- +title: Mount show +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Mount show + +Show attributes of a previously mounted external Vitess Cluster. + +``` +vtctldclient Mount show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 mount show --name ext1 +``` + +### Options + +``` + -h, --help help for show + --name string Name of the mount. +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient Mount](./vtctldclient_mount/) - Mount is used to link an external Vitess cluster in order to migrate data from it. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_unregister.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_unregister.md new file mode 100644 index 000000000..94fe2a176 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_unregister.md @@ -0,0 +1,41 @@ +--- +title: Mount unregister +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Mount unregister + +Unregister a previously mounted external Vitess Cluster. + +``` +vtctldclient Mount unregister +``` + +### Examples + +``` +vtctldclient --server localhost:15999 mount unregister --name ext1 +``` + +### Options + +``` + -h, --help help for unregister + --name string Name of the mount. +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient Mount](./vtctldclient_mount/) - Mount is used to link an external Vitess cluster in order to migrate data from it. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables.md new file mode 100644 index 000000000..eefddaa37 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables.md @@ -0,0 +1,42 @@ +--- +title: MoveTables +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient MoveTables + +Perform commands related to moving tables from a source keyspace to a target keyspace. + +### Options + +``` + --format string The format of the output; supported formats are: text,json. (default "text") + -h, --help help for MoveTables + --target-keyspace string Target keyspace for this workflow. + -w, --workflow string The workflow you want to perform the command on. +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient MoveTables cancel](./vtctldclient_movetables_cancel/) - Cancel a MoveTables VReplication workflow. +* [vtctldclient MoveTables complete](./vtctldclient_movetables_complete/) - Complete a MoveTables VReplication workflow. +* [vtctldclient MoveTables create](./vtctldclient_movetables_create/) - Create and optionally run a MoveTables VReplication workflow. +* [vtctldclient MoveTables reversetraffic](./vtctldclient_movetables_reversetraffic/) - Reverse traffic for a MoveTables VReplication workflow. +* [vtctldclient MoveTables show](./vtctldclient_movetables_show/) - Show the details for a MoveTables VReplication workflow. +* [vtctldclient MoveTables start](./vtctldclient_movetables_start/) - Start a MoveTables workflow. +* [vtctldclient MoveTables status](./vtctldclient_movetables_status/) - Show the current status for a MoveTables VReplication workflow. +* [vtctldclient MoveTables stop](./vtctldclient_movetables_stop/) - Stop a MoveTables workflow. +* [vtctldclient MoveTables switchtraffic](./vtctldclient_movetables_switchtraffic/) - Switch traffic for a MoveTables VReplication workflow. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_cancel.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_cancel.md new file mode 100644 index 000000000..8e6db5472 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_cancel.md @@ -0,0 +1,46 @@ +--- +title: MoveTables cancel +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient MoveTables cancel + +Cancel a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables cancel +``` + +### Examples + +``` +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer cancel +``` + +### Options + +``` + -h, --help help for cancel + --keep-data Keep the partially copied table data from the MoveTables workflow in the target keyspace. + --keep-routing-rules Keep the routing rules created for the MoveTables workflow. + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_complete.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_complete.md new file mode 100644 index 000000000..0bd3f6fa0 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_complete.md @@ -0,0 +1,48 @@ +--- +title: MoveTables complete +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient MoveTables complete + +Complete a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables complete +``` + +### Examples + +``` +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer complete +``` + +### Options + +``` + --dry-run Print the actions that would be taken and report any known errors that would have occurred. + -h, --help help for complete + --keep-data Keep the original source table data that was copied by the MoveTables workflow. + --keep-routing-rules Keep the routing rules in place that direct table traffic from the source keyspace to the target keyspace of the MoveTables workflow. + --rename-tables Keep the original source table data that was copied by the MoveTables workflow, but rename each table to '__old'. + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_create.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_create.md new file mode 100644 index 000000000..ca8cd1649 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_create.md @@ -0,0 +1,59 @@ +--- +title: MoveTables create +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient MoveTables create + +Create and optionally run a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables create +``` + +### Examples + +``` +vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer create --source-keyspace commerce --cells zone1 --cells zone2 --tablet-types replica +``` + +### Options + +``` + -a, --all-cells Copy table data from any existing cell. + --all-tables Copy all tables from the source. + --atomic-copy (EXPERIMENTAL) A single copy phase is run for all tables from the source. Use this, for example, if your source keyspace has tables which use foreign key constraints. + --auto-start Start the workflow after creating it. (default true) + -c, --cells strings Cells and/or CellAliases to copy table data from. + --defer-secondary-keys Defer secondary index creation for a table until after it has been copied. + --exclude-tables strings Source tables to exclude from copying. + -h, --help help for create + --no-routing-rules (Advanced) Do not create routing rules while creating the workflow. See the reference documentation for limitations if you use this flag. + --on-ddl string What to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE. (default "IGNORE") + --source-keyspace string Keyspace where the tables are being moved from. + --source-shards strings Source shards to copy data from when performing a partial MoveTables (experimental). + --source-time-zone string Specifying this causes any DATETIME fields to be converted from the given time zone into UTC. + --stop-after-copy Stop the workflow after it's finished copying the existing rows and before it starts replicating changes. + --tables strings Source tables to copy. + --tablet-types strings Source tablet types to replicate table data from (e.g. PRIMARY,REPLICA,RDONLY). + --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) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_reversetraffic.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_reversetraffic.md new file mode 100644 index 000000000..da47eef98 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_reversetraffic.md @@ -0,0 +1,50 @@ +--- +title: MoveTables reversetraffic +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient MoveTables reversetraffic + +Reverse traffic for a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables reversetraffic +``` + +### Examples + +``` +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer reversetraffic +``` + +### Options + +``` + -c, --cells strings Cells and/or CellAliases to switch traffic in. + --dry-run Print the actions that would be taken and report any known errors that would have occurred. + --enable-reverse-replication Setup replication going back to the original source keyspace to support rolling back the traffic cutover. (default true) + -h, --help help for reversetraffic + --max-replication-lag-allowed duration Allow traffic to be switched only if VReplication lag is below this. (default 30s) + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. + --tablet-types strings Tablet types to switch traffic for. + --timeout duration Specifies the maximum time to wait, in seconds, for VReplication to catch up on primary tablets. The traffic switch will be cancelled on timeout. (default 30s) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_show.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_show.md new file mode 100644 index 000000000..1ed642ded --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_show.md @@ -0,0 +1,45 @@ +--- +title: MoveTables show +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient MoveTables show + +Show the details for a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer show +``` + +### Options + +``` + -h, --help help for show + --include-logs Include recent logs for the workflow. (default true) + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_start.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_start.md new file mode 100644 index 000000000..f2b34d1a1 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_start.md @@ -0,0 +1,43 @@ +--- +title: MoveTables start +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient MoveTables start + +Start a MoveTables workflow. + +``` +vtctldclient MoveTables start +``` + +### Examples + +``` +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer start +``` + +### Options + +``` + -h, --help help for start +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_status.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_status.md new file mode 100644 index 000000000..05ff51aa2 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_status.md @@ -0,0 +1,44 @@ +--- +title: MoveTables status +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient MoveTables status + +Show the current status for a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables status +``` + +### Examples + +``` +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer status +``` + +### Options + +``` + -h, --help help for status + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_stop.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_stop.md new file mode 100644 index 000000000..751004065 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_stop.md @@ -0,0 +1,43 @@ +--- +title: MoveTables stop +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient MoveTables stop + +Stop a MoveTables workflow. + +``` +vtctldclient MoveTables stop +``` + +### Examples + +``` +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer stop +``` + +### Options + +``` + -h, --help help for stop +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_switchtraffic.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_switchtraffic.md new file mode 100644 index 000000000..304f4be5b --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_switchtraffic.md @@ -0,0 +1,51 @@ +--- +title: MoveTables switchtraffic +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient MoveTables switchtraffic + +Switch traffic for a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables switchtraffic +``` + +### Examples + +``` +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer switchtraffic --tablet-types "replica,rdonly" +``` + +### Options + +``` + -c, --cells strings Cells and/or CellAliases to switch traffic in. + --dry-run Print the actions that would be taken and report any known errors that would have occurred. + --enable-reverse-replication Setup replication going back to the original source keyspace to support rolling back the traffic cutover. (default true) + -h, --help help for switchtraffic + --initialize-target-sequences When moving tables from an unsharded keyspace to a sharded keyspace, initialize any sequences that are being used on the target when switching writes. + --max-replication-lag-allowed duration Allow traffic to be switched only if VReplication lag is below this. (default 30s) + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. + --tablet-types strings Tablet types to switch traffic for. + --timeout duration Specifies the maximum time to wait, in seconds, for VReplication to catch up on primary tablets. The traffic switch will be cancelled on timeout. (default 30s) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --format string The format of the output; supported formats are: text,json. (default "text") + --server string server to use for the connection (required) + --target-keyspace string Target keyspace for this workflow. + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL.md new file mode 100644 index 000000000..80f1d1d09 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL.md @@ -0,0 +1,39 @@ +--- +title: OnlineDDL +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient OnlineDDL + +Operates on online DDL (schema migrations). + +### Options + +``` + -h, --help help for OnlineDDL +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient OnlineDDL cancel](./vtctldclient_onlineddl_cancel/) - Cancel one or all migrations, terminating any running ones as needed. +* [vtctldclient OnlineDDL cleanup](./vtctldclient_onlineddl_cleanup/) - Mark a given schema migration ready for artifact cleanup. +* [vtctldclient OnlineDDL complete](./vtctldclient_onlineddl_complete/) - Complete one or all migrations executed with --postpone-completion +* [vtctldclient OnlineDDL force-cutover](./vtctldclient_onlineddl_force-cutover/) - Mark a given schema migration, or all pending migrations, for forced cut over. +* [vtctldclient OnlineDDL launch](./vtctldclient_onlineddl_launch/) - Launch one or all migrations executed with --postpone-launch +* [vtctldclient OnlineDDL retry](./vtctldclient_onlineddl_retry/) - Mark a given schema migration for retry. +* [vtctldclient OnlineDDL show](./vtctldclient_onlineddl_show/) - Display information about online DDL operations. +* [vtctldclient OnlineDDL throttle](./vtctldclient_onlineddl_throttle/) - Throttles one or all migrations +* [vtctldclient OnlineDDL unthrottle](./vtctldclient_onlineddl_unthrottle/) - Unthrottles one or all migrations + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cancel.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cancel.md new file mode 100644 index 000000000..a39f05785 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cancel.md @@ -0,0 +1,40 @@ +--- +title: OnlineDDL cancel +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient OnlineDDL cancel + +Cancel one or all migrations, terminating any running ones as needed. + +``` +vtctldclient OnlineDDL cancel +``` + +### Examples + +``` +OnlineDDL cancel test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 +``` + +### 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 + --server string server to use for the connection (required) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cleanup.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cleanup.md new file mode 100644 index 000000000..79f18770d --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cleanup.md @@ -0,0 +1,40 @@ +--- +title: OnlineDDL cleanup +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient OnlineDDL cleanup + +Mark a given schema migration ready for artifact cleanup. + +``` +vtctldclient OnlineDDL cleanup +``` + +### Examples + +``` +OnlineDDL cleanup test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 +``` + +### Options + +``` + -h, --help help for cleanup +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_complete.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_complete.md new file mode 100644 index 000000000..a4fa13e4a --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_complete.md @@ -0,0 +1,40 @@ +--- +title: OnlineDDL complete +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient OnlineDDL complete + +Complete one or all migrations executed with --postpone-completion + +``` +vtctldclient OnlineDDL complete +``` + +### Examples + +``` +OnlineDDL complete test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 +``` + +### Options + +``` + -h, --help help for complete +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_force-cutover.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_force-cutover.md new file mode 100644 index 000000000..11a92332a --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_force-cutover.md @@ -0,0 +1,40 @@ +--- +title: OnlineDDL force-cutover +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient OnlineDDL force-cutover + +Mark a given schema migration, or all pending migrations, for forced cut over. + +``` +vtctldclient OnlineDDL force-cutover +``` + +### Examples + +``` +OnlineDDL force-cutover test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 +``` + +### Options + +``` + -h, --help help for force-cutover +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_launch.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_launch.md new file mode 100644 index 000000000..33d15329e --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_launch.md @@ -0,0 +1,40 @@ +--- +title: OnlineDDL launch +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient OnlineDDL launch + +Launch one or all migrations executed with --postpone-launch + +``` +vtctldclient OnlineDDL launch +``` + +### Examples + +``` +OnlineDDL launch test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 +``` + +### Options + +``` + -h, --help help for launch +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_retry.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_retry.md new file mode 100644 index 000000000..399dd3f1d --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_retry.md @@ -0,0 +1,40 @@ +--- +title: OnlineDDL retry +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient OnlineDDL retry + +Mark a given schema migration for retry. + +``` +vtctldclient OnlineDDL retry +``` + +### Examples + +``` +vtctl OnlineDDL retry test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 +``` + +### Options + +``` + -h, --help help for retry +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_show.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_show.md new file mode 100644 index 000000000..dad5b9ef5 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_show.md @@ -0,0 +1,51 @@ +--- +title: OnlineDDL show +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient OnlineDDL show + +Display information about online DDL operations. + +``` +vtctldclient OnlineDDL show +``` + +### Examples + +``` +OnlineDDL show test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 +OnlineDDL show test_keyspace all +OnlineDDL show --order descending test_keyspace all +OnlineDDL show --limit 10 test_keyspace all +OnlineDDL show --skip 5 --limit 10 test_keyspace all +OnlineDDL show test_keyspace running +OnlineDDL show test_keyspace complete +OnlineDDL show test_keyspace failed +``` + +### Options + +``` + -h, --help help for show + --json Output JSON instead of human-readable table. + --limit uint Limit number of rows returned in output. + --order id Sort the results by id property of the Schema migration. (default "asc") + --skip uint Skip specified number of rows returned in output. +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_throttle.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_throttle.md new file mode 100644 index 000000000..7f9e0653c --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_throttle.md @@ -0,0 +1,40 @@ +--- +title: OnlineDDL throttle +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient OnlineDDL throttle + +Throttles one or all migrations + +``` +vtctldclient OnlineDDL throttle +``` + +### Examples + +``` +OnlineDDL throttle all +``` + +### Options + +``` + -h, --help help for throttle +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_unthrottle.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_unthrottle.md new file mode 100644 index 000000000..e2a060fac --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_unthrottle.md @@ -0,0 +1,40 @@ +--- +title: OnlineDDL unthrottle +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient OnlineDDL unthrottle + +Unthrottles one or all migrations + +``` +vtctldclient OnlineDDL unthrottle +``` + +### Examples + +``` +OnlineDDL unthrottle all +``` + +### Options + +``` + -h, --help help for unthrottle +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md index 91eea9f95..c50aebdef 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md @@ -1,7 +1,7 @@ --- title: ReloadSchemaKeyspace series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vtctldclient ReloadSchemaKeyspace @@ -14,9 +14,9 @@ vtctldclient ReloadSchemaKeyspace [--concurrency=] [--include-prima ### Options ``` - --concurrency uint32 Number of tablets to reload in parallel. Set to zero for unbounded concurrency. (default 10) - -h, --help help for ReloadSchemaKeyspace - --include-primary Also reload the primary tablets. + --concurrency int32 Number of tablets to reload in parallel. Set to zero for unbounded concurrency. (default 10) + -h, --help help for ReloadSchemaKeyspace + --include-primary Also reload the primary tablets. ``` ### Options inherited from parent commands diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md index 45f098a60..0d6057f70 100644 --- a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md @@ -1,7 +1,7 @@ --- title: ReloadSchemaShard series: vtctldclient -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vtctldclient ReloadSchemaShard @@ -14,9 +14,9 @@ vtctldclient ReloadSchemaShard [--concurrency=10] [--include-primary] [command] [command-flags] +``` + +### Options + +``` + -h, --help help for Workflow + -k, --keyspace string Keyspace context for the workflow. +``` + +### 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) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient Workflow delete](./vtctldclient_workflow_delete/) - Delete a VReplication workflow. +* [vtctldclient Workflow list](./vtctldclient_workflow_list/) - List the VReplication workflows in the given keyspace. +* [vtctldclient Workflow show](./vtctldclient_workflow_show/) - Show the details for a VReplication workflow. +* [vtctldclient Workflow start](./vtctldclient_workflow_start/) - Start a VReplication workflow. +* [vtctldclient Workflow stop](./vtctldclient_workflow_stop/) - Stop a VReplication workflow. +* [vtctldclient Workflow update](./vtctldclient_workflow_update/) - Update the configuration parameters for a VReplication workflow. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_delete.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_delete.md new file mode 100644 index 000000000..395e5314f --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_delete.md @@ -0,0 +1,45 @@ +--- +title: Workflow delete +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Workflow delete + +Delete a VReplication workflow. + +``` +vtctldclient Workflow delete +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer delete --workflow commerce2customer +``` + +### Options + +``` + -h, --help help for delete + --keep-data Keep the partially copied table data from the workflow in the target keyspace. + --keep-routing-rules Keep the routing rules created for the workflow. + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. + -w, --workflow string The workflow you want to delete. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + -k, --keyspace string Keyspace context for the workflow. + --server string server to use for the connection (required) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_list.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_list.md new file mode 100644 index 000000000..ce7f8c5ef --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_list.md @@ -0,0 +1,42 @@ +--- +title: Workflow list +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Workflow list + +List the VReplication workflows in the given keyspace. + +``` +vtctldclient Workflow list +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer list +``` + +### Options + +``` + -h, --help help for list + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + -k, --keyspace string Keyspace context for the workflow. + --server string server to use for the connection (required) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_show.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_show.md new file mode 100644 index 000000000..f34a75acc --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_show.md @@ -0,0 +1,44 @@ +--- +title: Workflow show +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Workflow show + +Show the details for a VReplication workflow. + +``` +vtctldclient Workflow show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer show --workflow commerce2customer +``` + +### Options + +``` + -h, --help help for show + --include-logs Include recent logs for the workflow. (default true) + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. + -w, --workflow string The workflow you want the details for. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + -k, --keyspace string Keyspace context for the workflow. + --server string server to use for the connection (required) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_start.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_start.md new file mode 100644 index 000000000..146d100d3 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_start.md @@ -0,0 +1,43 @@ +--- +title: Workflow start +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Workflow start + +Start a VReplication workflow. + +``` +vtctldclient Workflow start +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer start --workflow commerce2customer +``` + +### Options + +``` + -h, --help help for start + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. + -w, --workflow string The workflow you want to start. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + -k, --keyspace string Keyspace context for the workflow. + --server string server to use for the connection (required) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_stop.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_stop.md new file mode 100644 index 000000000..31401ea23 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_stop.md @@ -0,0 +1,43 @@ +--- +title: Workflow stop +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## vtctldclient Workflow stop + +Stop a VReplication workflow. + +``` +vtctldclient Workflow stop +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer stop --workflow commerce2customer +``` + +### Options + +``` + -h, --help help for stop + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. + -w, --workflow string The workflow you want to stop. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + -k, --keyspace string Keyspace context for the workflow. + --server string server to use for the connection (required) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_update.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_update.md new file mode 100644 index 000000000..30e50c964 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_update.md @@ -0,0 +1,47 @@ +--- +title: Workflow update +series: vtctldclient +commit: f751c8323ff52c90f288481b0bd92192f1734973 +--- +## 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. + --shards strings (Optional) Specifies a comma-separated list of shards to operate on. + -t, --tablet-types strings New source tablet types to replicate from (e.g. PRIMARY,REPLICA,RDONLY). + --tablet-types-in-order When performing source tablet selection, look for candidates in the type order as they are listed in the tablet-types flag. (default true) + -w, --workflow string The workflow you want to update. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + -k, --keyspace string Keyspace context for the workflow. + --server string server to use for the connection (required) + --topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") + --topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) + --topo-implementation string the topology implementation to use (default "etcd2") +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtgate/_index.md b/content/en/docs/19.0/reference/programs/vtgate/_index.md index f5f0f3c71..6959ae5ad 100644 --- a/content/en/docs/19.0/reference/programs/vtgate/_index.md +++ b/content/en/docs/19.0/reference/programs/vtgate/_index.md @@ -1,7 +1,7 @@ --- title: vtgate series: vtgate -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: 43ef6ae99f08fc573b00474e555af693911fee79 --- ## vtgate @@ -112,6 +112,7 @@ vtgate \ --grpc_server_keepalive_enforcement_policy_min_time duration gRPC server minimum keepalive time (default 10s) --grpc_server_keepalive_enforcement_policy_permit_without_stream gRPC server permit client keepalive pings even when there are no active streams (RPCs) --grpc_use_effective_callerid If set, and SSL is not used, will set the immediate caller id from the effective caller id's principal. + --healthcheck-init-concurrency int Concurrency of intiating healthchecks. This should be less than the golang max thread limit of 10000. (default 1024) --healthcheck_retry_delay duration health check retry delay (default 2ms) --healthcheck_timeout duration the health check timeout period (default 1m0s) -h, --help help for docgen @@ -181,6 +182,7 @@ vtgate \ --planner-version string Sets the default planner to use when the session has not changed it. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right --port int port for the server --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --proxy_protocol Enable HAProxy PROXY protocol on MySQL listener socket --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --query-timeout int Sets the default query timeout (in ms). Can be overridden by session variable (query_timeout) or comment directive (QUERY_TIMEOUT_MS) diff --git a/content/en/docs/19.0/reference/programs/vtgateclienttest/_index.md b/content/en/docs/19.0/reference/programs/vtgateclienttest/_index.md index 1c279e03c..783659f44 100644 --- a/content/en/docs/19.0/reference/programs/vtgateclienttest/_index.md +++ b/content/en/docs/19.0/reference/programs/vtgateclienttest/_index.md @@ -1,7 +1,7 @@ --- title: vtgateclienttest series: vtgateclienttest -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vtgateclienttest @@ -66,6 +66,7 @@ vtgateclienttest [flags] --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. --port int port for the server --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --security_policy string the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) --service_map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice diff --git a/content/en/docs/19.0/reference/programs/vtorc/_index.md b/content/en/docs/19.0/reference/programs/vtorc/_index.md index aa9722571..28d1f8efe 100644 --- a/content/en/docs/19.0/reference/programs/vtorc/_index.md +++ b/content/en/docs/19.0/reference/programs/vtorc/_index.md @@ -1,7 +1,7 @@ --- title: vtorc series: vtorc -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vtorc @@ -74,6 +74,7 @@ vtorc \ --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. --port int port for the server --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --prevent-cross-cell-failover Prevent VTOrc from promoting a primary in a different cell than the current primary in case of a failover --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --reasonable-replication-lag duration Maximum replication lag on replicas which is deemed to be acceptable (default 10s) @@ -93,7 +94,7 @@ vtorc \ --table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class --tablet_manager_grpc_ca string the server ca to use to validate servers when connecting --tablet_manager_grpc_cert string the cert to use to connect - --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8) + --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8) --tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100) --tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting --tablet_manager_grpc_key string the key to use to connect diff --git a/content/en/docs/19.0/reference/programs/vttablet/_index.md b/content/en/docs/19.0/reference/programs/vttablet/_index.md index cccaa9816..2c4e61e19 100644 --- a/content/en/docs/19.0/reference/programs/vttablet/_index.md +++ b/content/en/docs/19.0/reference/programs/vttablet/_index.md @@ -1,7 +1,7 @@ --- title: vttablet series: vttablet -commit: 6b481a7dc8639a070f8aa42773aa9c5a497f79c7 +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vttablet @@ -272,6 +272,7 @@ vttablet \ --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --port int port for the server --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --pt-osc-path string override default pt-online-schema-change binary full path --publish_retry_interval duration how long vttablet waits to retry publishing the tablet record (default 30s) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) @@ -367,7 +368,7 @@ vttablet \ --tablet_hostname string if not empty, this hostname will be assumed instead of trying to resolve it --tablet_manager_grpc_ca string the server ca to use to validate servers when connecting --tablet_manager_grpc_cert string the cert to use to connect - --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8) + --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8) --tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100) --tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting --tablet_manager_grpc_key string the key to use to connect diff --git a/content/en/docs/19.0/reference/programs/vttestserver/_index.md b/content/en/docs/19.0/reference/programs/vttestserver/_index.md index af40f3872..33b2ad648 100644 --- a/content/en/docs/19.0/reference/programs/vttestserver/_index.md +++ b/content/en/docs/19.0/reference/programs/vttestserver/_index.md @@ -1,7 +1,7 @@ --- title: vttestserver series: vttestserver -commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9 +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## vttestserver @@ -109,6 +109,7 @@ vttestserver [flags] --pool_hostname_resolve_interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled) --port int Port to use for vtcombo. If this is 0, a random port will be chosen. --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --proto_topo string Define the fake cluster topology as a compact text format encoded vttest proto. See vttest.proto for more information. --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --queryserver-config-transaction-timeout float query server transaction timeout (in seconds), a transaction will be killed if it takes longer than this value @@ -128,7 +129,7 @@ vttestserver [flags] --tablet_hostname string The hostname to use for the tablet otherwise it will be derived from OS' hostname (default "localhost") --tablet_manager_grpc_ca string the server ca to use to validate servers when connecting --tablet_manager_grpc_cert string the cert to use to connect - --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8) + --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App} and CheckThrottler) (default 8) --tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100) --tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting --tablet_manager_grpc_key string the key to use to connect diff --git a/content/en/docs/19.0/reference/programs/zkctl/_index.md b/content/en/docs/19.0/reference/programs/zkctl/_index.md index 3f674c65d..161a6ad7e 100644 --- a/content/en/docs/19.0/reference/programs/zkctl/_index.md +++ b/content/en/docs/19.0/reference/programs/zkctl/_index.md @@ -1,7 +1,7 @@ --- title: zkctl series: zkctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## zkctl @@ -26,6 +26,7 @@ Initializes and controls zookeeper with Vitess-specific configuration. --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) --logtostderr log to standard error instead of files --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1) --v Level log level for V logs diff --git a/content/en/docs/19.0/reference/programs/zkctl/zkctl_init.md b/content/en/docs/19.0/reference/programs/zkctl/zkctl_init.md index 373b71339..ce95eca2a 100644 --- a/content/en/docs/19.0/reference/programs/zkctl/zkctl_init.md +++ b/content/en/docs/19.0/reference/programs/zkctl/zkctl_init.md @@ -1,7 +1,7 @@ --- title: init series: zkctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## zkctl init @@ -24,7 +24,7 @@ zkctl init [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 []) + --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). --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) @@ -35,6 +35,7 @@ zkctl init [flags] --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) --logtostderr log to standard error instead of files --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1) --v Level log level for V logs diff --git a/content/en/docs/19.0/reference/programs/zkctl/zkctl_shutdown.md b/content/en/docs/19.0/reference/programs/zkctl/zkctl_shutdown.md index 4deb6aea9..7fe97f385 100644 --- a/content/en/docs/19.0/reference/programs/zkctl/zkctl_shutdown.md +++ b/content/en/docs/19.0/reference/programs/zkctl/zkctl_shutdown.md @@ -1,7 +1,7 @@ --- title: shutdown series: zkctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## zkctl shutdown @@ -24,7 +24,7 @@ zkctl shutdown [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 []) + --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). --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) @@ -35,6 +35,7 @@ zkctl shutdown [flags] --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) --logtostderr log to standard error instead of files --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1) --v Level log level for V logs diff --git a/content/en/docs/19.0/reference/programs/zkctl/zkctl_start.md b/content/en/docs/19.0/reference/programs/zkctl/zkctl_start.md index b8864c90b..a41fd5a8d 100644 --- a/content/en/docs/19.0/reference/programs/zkctl/zkctl_start.md +++ b/content/en/docs/19.0/reference/programs/zkctl/zkctl_start.md @@ -1,7 +1,7 @@ --- title: start series: zkctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## zkctl start @@ -24,7 +24,7 @@ zkctl start [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 []) + --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). --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) @@ -35,6 +35,7 @@ zkctl start [flags] --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) --logtostderr log to standard error instead of files --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1) --v Level log level for V logs diff --git a/content/en/docs/19.0/reference/programs/zkctl/zkctl_teardown.md b/content/en/docs/19.0/reference/programs/zkctl/zkctl_teardown.md index 49f89fc1e..306a8ec11 100644 --- a/content/en/docs/19.0/reference/programs/zkctl/zkctl_teardown.md +++ b/content/en/docs/19.0/reference/programs/zkctl/zkctl_teardown.md @@ -1,7 +1,7 @@ --- title: teardown series: zkctl -commit: c823b86a19bfeb9a6a411a75caf492464caf697e +commit: f751c8323ff52c90f288481b0bd92192f1734973 --- ## zkctl teardown @@ -24,7 +24,7 @@ zkctl teardown [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 []) + --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). --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) @@ -35,6 +35,7 @@ zkctl teardown [flags] --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) --logtostderr log to standard error instead of files --pprof strings enable profiling + --pprof-http enable pprof http endpoints (default true) --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) --stderrthreshold severityFlag logs at or above this threshold go to stderr (default 1) --v Level log level for V logs