From 67a5cf3071923c5039cd57232c4da93db645420f Mon Sep 17 00:00:00 2001 From: "vitess-bot[bot]" <108069721+vitess-bot[bot]@users.noreply.github.com> Date: Tue, 6 Feb 2024 22:40:20 +0000 Subject: [PATCH] synchronize cobradocs with vitessio/vitess#15153 --- .../vtctldclient/vtctldclient_workflow.md | 32 ++++++++ .../vtctldclient_workflow_update.md | 41 ++++++++++ .../programs/mysqlctl/mysqlctl_init.md | 4 +- .../programs/mysqlctl/mysqlctl_init_config.md | 4 +- .../programs/mysqlctl/mysqlctl_position.md | 4 +- .../mysqlctl/mysqlctl_reinit_config.md | 4 +- .../programs/mysqlctl/mysqlctl_shutdown.md | 4 +- .../programs/mysqlctl/mysqlctl_start.md | 4 +- .../programs/mysqlctl/mysqlctl_teardown.md | 4 +- .../vtctldclient/vtctldclient_LookupVindex.md | 33 ++++++++ .../vtctldclient_LookupVindex_cancel.md | 39 +++++++++ .../vtctldclient_LookupVindex_create.md | 50 +++++++++++ .../vtctldclient_LookupVindex_externalize.md | 40 +++++++++ .../vtctldclient_LookupVindex_show.md | 39 +++++++++ .../vtctldclient/vtctldclient_Materialize.md | 35 ++++++++ .../vtctldclient_Materialize_cancel.md | 40 +++++++++ .../vtctldclient_Materialize_create.md | 76 +++++++++++++++++ .../vtctldclient_Materialize_show.md | 41 ++++++++++ .../vtctldclient_Materialize_start.md | 40 +++++++++ .../vtctldclient_Materialize_stop.md | 40 +++++++++ .../vtctldclient/vtctldclient_Migrate.md | 35 ++++++++ .../vtctldclient_Migrate_cancel.md | 40 +++++++++ .../vtctldclient_Migrate_complete.md | 40 +++++++++ .../vtctldclient_Migrate_create.md | 55 +++++++++++++ .../vtctldclient/vtctldclient_Migrate_show.md | 41 ++++++++++ .../vtctldclient_Migrate_status.md | 40 +++++++++ .../vtctldclient/vtctldclient_Mount.md | 31 +++++++ .../vtctldclient/vtctldclient_Mount_list.md | 37 +++++++++ .../vtctldclient_Mount_register.md | 41 ++++++++++ .../vtctldclient/vtctldclient_Mount_show.md | 38 +++++++++ .../vtctldclient_Mount_unregister.md | 38 +++++++++ .../vtctldclient/vtctldclient_MoveTables.md | 39 +++++++++ .../vtctldclient_MoveTables_cancel.md | 42 ++++++++++ .../vtctldclient_MoveTables_complete.md | 44 ++++++++++ .../vtctldclient_MoveTables_create.md | 56 +++++++++++++ .../vtctldclient_MoveTables_reversetraffic.md | 46 +++++++++++ .../vtctldclient_MoveTables_show.md | 41 ++++++++++ .../vtctldclient_MoveTables_start.md | 40 +++++++++ .../vtctldclient_MoveTables_status.md | 40 +++++++++ .../vtctldclient_MoveTables_stop.md | 40 +++++++++ .../vtctldclient_MoveTables_switchtraffic.md | 47 +++++++++++ .../vtctldclient/vtctldclient_OnlineDDL.md | 35 ++++++++ .../vtctldclient_OnlineDDL_cancel.md | 37 +++++++++ .../vtctldclient_OnlineDDL_cleanup.md | 37 +++++++++ .../vtctldclient_OnlineDDL_complete.md | 37 +++++++++ .../vtctldclient_OnlineDDL_launch.md | 37 +++++++++ .../vtctldclient_OnlineDDL_retry.md | 37 +++++++++ .../vtctldclient_OnlineDDL_show.md | 48 +++++++++++ .../vtctldclient_OnlineDDL_throttle.md | 37 +++++++++ .../vtctldclient_OnlineDDL_unthrottle.md | 37 +++++++++ .../vtctldclient/vtctldclient_Reshard.md | 39 +++++++++ .../vtctldclient_Reshard_cancel.md | 40 +++++++++ .../vtctldclient_Reshard_complete.md | 40 +++++++++ .../vtctldclient_Reshard_create.md | 51 ++++++++++++ .../vtctldclient_Reshard_reversetraffic.md | 46 +++++++++++ .../vtctldclient/vtctldclient_Reshard_show.md | 41 ++++++++++ .../vtctldclient_Reshard_start.md | 40 +++++++++ .../vtctldclient_Reshard_status.md | 40 +++++++++ .../vtctldclient/vtctldclient_Reshard_stop.md | 40 +++++++++ .../vtctldclient_Reshard_switchtraffic.md | 46 +++++++++++ .../vtctldclient/vtctldclient_VDiff.md | 35 ++++++++ .../vtctldclient/vtctldclient_VDiff_create.md | 55 +++++++++++++ .../vtctldclient/vtctldclient_VDiff_delete.md | 41 ++++++++++ .../vtctldclient/vtctldclient_VDiff_resume.md | 40 +++++++++ .../vtctldclient/vtctldclient_VDiff_show.md | 43 ++++++++++ .../vtctldclient/vtctldclient_VDiff_stop.md | 40 +++++++++ .../vtctldclient/vtctldclient_Workflow.md | 38 +++++++++ .../vtctldclient_Workflow_delete.md | 41 ++++++++++ .../vtctldclient_Workflow_list.md | 38 +++++++++ .../vtctldclient_Workflow_show.md | 40 +++++++++ .../vtctldclient_Workflow_start.md | 39 +++++++++ .../vtctldclient_Workflow_stop.md | 39 +++++++++ .../vtctldclient_Workflow_update.md | 43 ++++++++++ .../reference/programs/zkctl/zkctl_init.md | 4 +- .../programs/zkctl/zkctl_shutdown.md | 4 +- .../reference/programs/zkctl/zkctl_start.md | 4 +- .../programs/zkctl/zkctl_teardown.md | 4 +- .../programs/mysqlctl/mysqlctl_init.md | 4 +- .../programs/mysqlctl/mysqlctl_init_config.md | 4 +- .../programs/mysqlctl/mysqlctl_position.md | 4 +- .../mysqlctl/mysqlctl_reinit_config.md | 4 +- .../programs/mysqlctl/mysqlctl_shutdown.md | 4 +- .../programs/mysqlctl/mysqlctl_start.md | 4 +- .../programs/mysqlctl/mysqlctl_teardown.md | 4 +- .../reference/programs/vtbackup/_index.md | 4 +- .../19.0/reference/programs/vtcombo/_index.md | 4 +- .../19.0/reference/programs/vtctld/_index.md | 4 +- .../vtctldclient/vtctldclient_LookupVindex.md | 36 ++++++++ .../vtctldclient_LookupVindex_cancel.md | 42 ++++++++++ .../vtctldclient_LookupVindex_create.md | 53 ++++++++++++ .../vtctldclient_LookupVindex_externalize.md | 43 ++++++++++ .../vtctldclient_LookupVindex_show.md | 42 ++++++++++ .../vtctldclient/vtctldclient_Materialize.md | 38 +++++++++ .../vtctldclient_Materialize_cancel.md | 43 ++++++++++ .../vtctldclient_Materialize_create.md | 82 +++++++++++++++++++ .../vtctldclient_Materialize_show.md | 44 ++++++++++ .../vtctldclient_Materialize_start.md | 43 ++++++++++ .../vtctldclient_Materialize_stop.md | 43 ++++++++++ .../vtctldclient/vtctldclient_Migrate.md | 38 +++++++++ .../vtctldclient_Migrate_cancel.md | 43 ++++++++++ .../vtctldclient_Migrate_complete.md | 43 ++++++++++ .../vtctldclient_Migrate_create.md | 58 +++++++++++++ .../vtctldclient/vtctldclient_Migrate_show.md | 44 ++++++++++ .../vtctldclient_Migrate_status.md | 43 ++++++++++ .../vtctldclient/vtctldclient_Mount.md | 34 ++++++++ .../vtctldclient/vtctldclient_Mount_list.md | 40 +++++++++ .../vtctldclient_Mount_register.md | 44 ++++++++++ .../vtctldclient/vtctldclient_Mount_show.md | 41 ++++++++++ .../vtctldclient_Mount_unregister.md | 41 ++++++++++ .../vtctldclient/vtctldclient_MoveTables.md | 42 ++++++++++ .../vtctldclient_MoveTables_cancel.md | 46 +++++++++++ .../vtctldclient_MoveTables_complete.md | 48 +++++++++++ .../vtctldclient_MoveTables_create.md | 59 +++++++++++++ .../vtctldclient_MoveTables_reversetraffic.md | 50 +++++++++++ .../vtctldclient_MoveTables_show.md | 45 ++++++++++ .../vtctldclient_MoveTables_start.md | 43 ++++++++++ .../vtctldclient_MoveTables_status.md | 44 ++++++++++ .../vtctldclient_MoveTables_stop.md | 43 ++++++++++ .../vtctldclient_MoveTables_switchtraffic.md | 51 ++++++++++++ .../vtctldclient/vtctldclient_OnlineDDL.md | 39 +++++++++ .../vtctldclient_OnlineDDL_cancel.md | 40 +++++++++ .../vtctldclient_OnlineDDL_cleanup.md | 40 +++++++++ .../vtctldclient_OnlineDDL_complete.md | 40 +++++++++ .../vtctldclient_OnlineDDL_force-cutover.md | 40 +++++++++ .../vtctldclient_OnlineDDL_launch.md | 40 +++++++++ .../vtctldclient_OnlineDDL_retry.md | 40 +++++++++ .../vtctldclient_OnlineDDL_show.md | 51 ++++++++++++ .../vtctldclient_OnlineDDL_throttle.md | 40 +++++++++ .../vtctldclient_OnlineDDL_unthrottle.md | 40 +++++++++ .../vtctldclient/vtctldclient_Reshard.md | 42 ++++++++++ .../vtctldclient_Reshard_cancel.md | 43 ++++++++++ .../vtctldclient_Reshard_complete.md | 43 ++++++++++ .../vtctldclient_Reshard_create.md | 54 ++++++++++++ .../vtctldclient_Reshard_reversetraffic.md | 49 +++++++++++ .../vtctldclient/vtctldclient_Reshard_show.md | 44 ++++++++++ .../vtctldclient_Reshard_start.md | 43 ++++++++++ .../vtctldclient_Reshard_status.md | 43 ++++++++++ .../vtctldclient/vtctldclient_Reshard_stop.md | 43 ++++++++++ .../vtctldclient_Reshard_switchtraffic.md | 49 +++++++++++ .../vtctldclient/vtctldclient_VDiff.md | 38 +++++++++ .../vtctldclient/vtctldclient_VDiff_create.md | 60 ++++++++++++++ .../vtctldclient/vtctldclient_VDiff_delete.md | 44 ++++++++++ .../vtctldclient/vtctldclient_VDiff_resume.md | 43 ++++++++++ .../vtctldclient/vtctldclient_VDiff_show.md | 46 +++++++++++ .../vtctldclient/vtctldclient_VDiff_stop.md | 43 ++++++++++ .../vtctldclient/vtctldclient_Workflow.md | 41 ++++++++++ .../vtctldclient_Workflow_delete.md | 45 ++++++++++ .../vtctldclient_Workflow_list.md | 42 ++++++++++ .../vtctldclient_Workflow_show.md | 44 ++++++++++ .../vtctldclient_Workflow_start.md | 43 ++++++++++ .../vtctldclient_Workflow_stop.md | 43 ++++++++++ .../vtctldclient_Workflow_update.md | 47 +++++++++++ .../19.0/reference/programs/vtorc/_index.md | 4 +- .../reference/programs/vttablet/_index.md | 4 +- .../reference/programs/vttestserver/_index.md | 4 +- .../reference/programs/zkctl/zkctl_init.md | 4 +- .../programs/zkctl/zkctl_shutdown.md | 4 +- .../reference/programs/zkctl/zkctl_start.md | 4 +- .../programs/zkctl/zkctl_teardown.md | 4 +- 159 files changed, 5661 insertions(+), 56 deletions(-) create mode 100644 content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_workflow.md create mode 100644 content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_workflow_update.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_cancel.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_create.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_externalize.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_show.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_cancel.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_create.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_show.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_start.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_stop.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_cancel.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_complete.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_create.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_show.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_status.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_list.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_register.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_show.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_unregister.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_cancel.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_complete.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_create.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_reversetraffic.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_show.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_start.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_status.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_stop.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_switchtraffic.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cancel.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cleanup.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_complete.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_launch.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_retry.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_show.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_throttle.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_unthrottle.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_cancel.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_complete.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_create.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_reversetraffic.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_show.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_start.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_status.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_stop.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_switchtraffic.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_create.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_delete.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_resume.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_show.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_stop.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_delete.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_list.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_show.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_start.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_stop.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_update.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_cancel.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_create.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_externalize.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_show.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_cancel.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_create.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_show.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_start.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_stop.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_cancel.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_complete.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_create.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_show.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_status.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_list.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_register.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_show.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount_unregister.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_cancel.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_complete.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_create.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_reversetraffic.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_show.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_start.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_status.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_stop.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables_switchtraffic.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cancel.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cleanup.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_complete.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_force-cutover.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_launch.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_retry.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_show.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_throttle.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_unthrottle.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_cancel.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_complete.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_create.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_reversetraffic.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_show.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_start.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_status.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_stop.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_switchtraffic.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_create.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_delete.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_resume.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_show.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_stop.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_delete.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_list.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_show.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_start.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_stop.md create mode 100644 content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow_update.md diff --git a/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_workflow.md b/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_workflow.md new file mode 100644 index 000000000..0e7110ecd --- /dev/null +++ b/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_workflow.md @@ -0,0 +1,32 @@ +--- +title: workflow +series: vtctldclient +commit: 9a3628037518bc108c636220319f3c7385b2a559 +--- +## vtctldclient workflow + +Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace + +``` +vtctldclient workflow +``` + +### Options + +``` + -h, --help help for workflow + -k, --keyspace string Keyspace context for the workflow (required) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout for the total command (default 1h0m0s) + --server string server to use for connection (required) +``` + +### SEE ALSO + +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient workflow update](./vtctldclient_workflow_update/) - Update the configuration parameters for a VReplication workflow + diff --git a/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_workflow_update.md b/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_workflow_update.md new file mode 100644 index 000000000..649a6a91e --- /dev/null +++ b/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_workflow_update.md @@ -0,0 +1,41 @@ +--- +title: workflow update +series: vtctldclient +commit: 9a3628037518bc108c636220319f3c7385b2a559 +--- +## vtctldclient workflow update + +Update the configuration parameters for a VReplication workflow + +``` +vtctldclient workflow update +``` + +### Examples + +``` +vtctldclient --server=localhost:15999 workflow --keyspace=customer update --workflow=commerce2customer --cells "zone1" --cells "zone2" -c "zone3,zone4" -c "zone5" +``` + +### Options + +``` + -c, --cells strings New Cell(s) or CellAlias(es) (comma-separated) to replicate from + -h, --help help for update + --on-ddl string New instruction on what to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE + -t, --tablet-types strings New source tablet types to replicate from (e.g. PRIMARY,REPLICA,RDONLY) + -w, --workflow string The workflow you want to update (required) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout for the total command (default 1h0m0s) + -k, --keyspace string Keyspace context for the workflow (required) + --server string server to use for connection (required) +``` + +### SEE ALSO + +* [vtctldclient workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace + diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md index 1e180c436..a2b86e1b4 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md @@ -1,7 +1,7 @@ --- title: init series: mysqlctl -commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## 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 diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md index b70d1ea1c..e77897c6c 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md @@ -1,7 +1,7 @@ --- title: init config series: mysqlctl -commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## 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 diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md index 1f988948c..67a0871ec 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md @@ -1,7 +1,7 @@ --- title: position series: mysqlctl -commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## 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 diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md index 4ccc1041a..ea24659d7 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md @@ -1,7 +1,7 @@ --- title: reinit config series: mysqlctl -commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## 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 diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md index 00885fee9..fe5ea4d26 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md @@ -1,7 +1,7 @@ --- title: shutdown series: mysqlctl -commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## 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 diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md index 04b0ee930..d07396f5b 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md @@ -1,7 +1,7 @@ --- title: start series: mysqlctl -commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## 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 diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md index 9cfbc3d7b..be153737f 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md @@ -1,7 +1,7 @@ --- title: teardown series: mysqlctl -commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## 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 diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md new file mode 100644 index 000000000..a15a2dc71 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md @@ -0,0 +1,33 @@ +--- +title: LookupVindex +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient LookupVindex + +Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows. + +### Options + +``` + -h, --help help for LookupVindex + --name string The name of the Lookup Vindex to create. This will also be the name of the VReplication workflow created to backfill the Lookup Vindex. + --table-keyspace string The keyspace to create the lookup table in. This is also where the VReplication workflow is created to backfill the Lookup Vindex. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --server string server to use for the connection (required) +``` + +### SEE ALSO + +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient LookupVindex cancel](./vtctldclient_lookupvindex_cancel/) - Cancel the VReplication workflow that backfills the Lookup Vindex. +* [vtctldclient LookupVindex create](./vtctldclient_lookupvindex_create/) - Create the Lookup Vindex in the specified keyspace and backfill it with a VReplication workflow. +* [vtctldclient LookupVindex externalize](./vtctldclient_lookupvindex_externalize/) - Externalize the Lookup Vindex. If the Vindex has an owner the VReplication workflow will also be deleted. +* [vtctldclient LookupVindex show](./vtctldclient_lookupvindex_show/) - Show the status of the VReplication workflow that backfills the Lookup Vindex. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_cancel.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_cancel.md new file mode 100644 index 000000000..f571af5d2 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_cancel.md @@ -0,0 +1,39 @@ +--- +title: LookupVindex cancel +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient LookupVindex cancel + +Cancel the VReplication workflow that backfills the Lookup Vindex. + +``` +vtctldclient LookupVindex cancel +``` + +### Examples + +``` +vtctldclient --server localhost:15999 LookupVindex --name corder_lookup_vdx --table-keyspace customer cancel +``` + +### Options + +``` + -h, --help help for cancel +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --name string The name of the Lookup Vindex to create. This will also be the name of the VReplication workflow created to backfill the Lookup Vindex. + --server string server to use for the connection (required) + --table-keyspace string The keyspace to create the lookup table in. This is also where the VReplication workflow is created to backfill the Lookup Vindex. +``` + +### SEE ALSO + +* [vtctldclient LookupVindex](./vtctldclient_lookupvindex/) - Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_create.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_create.md new file mode 100644 index 000000000..a790f7cf3 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_create.md @@ -0,0 +1,50 @@ +--- +title: LookupVindex create +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient LookupVindex create + +Create the Lookup Vindex in the specified keyspace and backfill it with a VReplication workflow. + +``` +vtctldclient LookupVindex create +``` + +### Examples + +``` +vtctldclient --server localhost:15999 LookupVindex --name corder_lookup_vdx --table-keyspace customer create --keyspace customer --type consistent_lookup_unique --table-owner corder --table-owner-columns sku --table-name corder_lookup_tbl --table-vindex-type unicode_loose_xxhash +``` + +### Options + +``` + --cells strings Cells to look in for source tablets to replicate from. + --continue-after-copy-with-owner Vindex will continue materialization after the backfill completes when an owner is provided. (default true) + -h, --help help for create + --ignore-nulls Do not add corresponding records in the lookup table if any of the owner table's 'from' fields are NULL. + --keyspace string The keyspace to create the Lookup Vindex in. This is also where the table-owner must exist. + --table-name string The name of the lookup table. If not specified, then it will be created using the same name as the Lookup Vindex. + --table-owner string The table holding the data which we should use to backfill the Lookup Vindex. This must exist in the same keyspace as the Lookup Vindex. + --table-owner-columns strings The columns to read from the owner table. These will be used to build the hash which gets stored as the keyspace_id value in the lookup table. + --table-vindex-type string The primary vindex name/type to use for the lookup table, if the table-keyspace is sharded. This must match the name of a vindex defined in the table-keyspace. If no value is provided then the default type will be used based on the table-owner-columns types. + --tablet-types strings Source tablet types to replicate from. + --tablet-types-in-preference-order When performing source tablet selection, look for candidates in the type order as they are listed in the tablet-types flag. (default true) + --type string The type of Lookup Vindex to create. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --name string The name of the Lookup Vindex to create. This will also be the name of the VReplication workflow created to backfill the Lookup Vindex. + --server string server to use for the connection (required) + --table-keyspace string The keyspace to create the lookup table in. This is also where the VReplication workflow is created to backfill the Lookup Vindex. +``` + +### SEE ALSO + +* [vtctldclient LookupVindex](./vtctldclient_lookupvindex/) - Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_externalize.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_externalize.md new file mode 100644 index 000000000..6d413613f --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_externalize.md @@ -0,0 +1,40 @@ +--- +title: LookupVindex externalize +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. +``` + +### 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/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_show.md new file mode 100644 index 000000000..ba4255d35 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_show.md @@ -0,0 +1,39 @@ +--- +title: LookupVindex show +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. +``` + +### 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/18.0/reference/programs/vtctldclient/vtctldclient_Materialize.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize.md new file mode 100644 index 000000000..e85867c5f --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize.md @@ -0,0 +1,35 @@ +--- +title: Materialize +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### 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/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_cancel.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_cancel.md new file mode 100644 index 000000000..4e496b139 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_cancel.md @@ -0,0 +1,40 @@ +--- +title: Materialize cancel +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_create.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_create.md new file mode 100644 index 000000000..c5abe80d0 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_create.md @@ -0,0 +1,76 @@ +--- +title: Materialize create +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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 + --source-keyspace string Keyspace where the tables queried in the 'source_expression' values within table-settings live. + --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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_show.md new file mode 100644 index 000000000..d8c06001e --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_show.md @@ -0,0 +1,41 @@ +--- +title: Materialize show +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_start.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_start.md new file mode 100644 index 000000000..80659c545 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_start.md @@ -0,0 +1,40 @@ +--- +title: Materialize start +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_stop.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_stop.md new file mode 100644 index 000000000..e2dc8b37d --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Materialize_stop.md @@ -0,0 +1,40 @@ +--- +title: Materialize stop +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_Migrate.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate.md new file mode 100644 index 000000000..20b15b770 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate.md @@ -0,0 +1,35 @@ +--- +title: Migrate +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### 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/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_cancel.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_cancel.md new file mode 100644 index 000000000..5dd3baccc --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_cancel.md @@ -0,0 +1,40 @@ +--- +title: Migrate cancel +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_complete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_complete.md new file mode 100644 index 000000000..c84ab1fb7 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_complete.md @@ -0,0 +1,40 @@ +--- +title: Migrate complete +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_create.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_create.md new file mode 100644 index 000000000..df278e3cd --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_create.md @@ -0,0 +1,55 @@ +--- +title: Migrate create +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_show.md new file mode 100644 index 000000000..4f1fdf26c --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_show.md @@ -0,0 +1,41 @@ +--- +title: Migrate show +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_status.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_status.md new file mode 100644 index 000000000..3dd556474 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Migrate_status.md @@ -0,0 +1,40 @@ +--- +title: Migrate status +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_Mount.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount.md new file mode 100644 index 000000000..bc6009f86 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount.md @@ -0,0 +1,31 @@ +--- +title: Mount +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### 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/18.0/reference/programs/vtctldclient/vtctldclient_Mount_list.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_list.md new file mode 100644 index 000000000..b278acdee --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_list.md @@ -0,0 +1,37 @@ +--- +title: Mount list +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### 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/18.0/reference/programs/vtctldclient/vtctldclient_Mount_register.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_register.md new file mode 100644 index 000000000..bfa388c39 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_register.md @@ -0,0 +1,41 @@ +--- +title: Mount register +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### 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/18.0/reference/programs/vtctldclient/vtctldclient_Mount_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_show.md new file mode 100644 index 000000000..43466da1d --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_show.md @@ -0,0 +1,38 @@ +--- +title: Mount show +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### 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/18.0/reference/programs/vtctldclient/vtctldclient_Mount_unregister.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_unregister.md new file mode 100644 index 000000000..5bb28b870 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Mount_unregister.md @@ -0,0 +1,38 @@ +--- +title: Mount unregister +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### 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/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables.md new file mode 100644 index 000000000..b20c5f0e0 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables.md @@ -0,0 +1,39 @@ +--- +title: MoveTables +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### 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/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_cancel.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_cancel.md new file mode 100644 index 000000000..7e1f73512 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_cancel.md @@ -0,0 +1,42 @@ +--- +title: MoveTables cancel +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. +``` + +### 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_complete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_complete.md new file mode 100644 index 000000000..cb0b3213b --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_complete.md @@ -0,0 +1,44 @@ +--- +title: MoveTables complete +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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'. +``` + +### 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_create.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_create.md new file mode 100644 index 000000000..c8fcc3a2b --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_create.md @@ -0,0 +1,56 @@ +--- +title: MoveTables create +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_reversetraffic.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_reversetraffic.md new file mode 100644 index 000000000..290172007 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_reversetraffic.md @@ -0,0 +1,46 @@ +--- +title: MoveTables reversetraffic +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) + --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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_show.md new file mode 100644 index 000000000..0bc134aad --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_show.md @@ -0,0 +1,41 @@ +--- +title: MoveTables show +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_start.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_start.md new file mode 100644 index 000000000..462c81664 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_start.md @@ -0,0 +1,40 @@ +--- +title: MoveTables start +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_status.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_status.md new file mode 100644 index 000000000..183c16ebf --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_status.md @@ -0,0 +1,40 @@ +--- +title: MoveTables status +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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 +``` + +### 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_stop.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_stop.md new file mode 100644 index 000000000..a634d551d --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_stop.md @@ -0,0 +1,40 @@ +--- +title: MoveTables stop +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_switchtraffic.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_switchtraffic.md new file mode 100644 index 000000000..b0c77a179 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables_switchtraffic.md @@ -0,0 +1,47 @@ +--- +title: MoveTables switchtraffic +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) + --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. + -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/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL.md new file mode 100644 index 000000000..524f48b18 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL.md @@ -0,0 +1,35 @@ +--- +title: OnlineDDL +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### 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 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/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cancel.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cancel.md new file mode 100644 index 000000000..0e2843b51 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cancel.md @@ -0,0 +1,37 @@ +--- +title: OnlineDDL cancel +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cleanup.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cleanup.md new file mode 100644 index 000000000..89019abb5 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_cleanup.md @@ -0,0 +1,37 @@ +--- +title: OnlineDDL cleanup +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_complete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_complete.md new file mode 100644 index 000000000..7c93652b9 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_complete.md @@ -0,0 +1,37 @@ +--- +title: OnlineDDL complete +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_launch.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_launch.md new file mode 100644 index 000000000..aa99a6748 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_launch.md @@ -0,0 +1,37 @@ +--- +title: OnlineDDL launch +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_retry.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_retry.md new file mode 100644 index 000000000..448136a42 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_retry.md @@ -0,0 +1,37 @@ +--- +title: OnlineDDL retry +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_show.md new file mode 100644 index 000000000..1603ae74f --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_show.md @@ -0,0 +1,48 @@ +--- +title: OnlineDDL show +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_throttle.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_throttle.md new file mode 100644 index 000000000..487b6c277 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_throttle.md @@ -0,0 +1,37 @@ +--- +title: OnlineDDL throttle +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_unthrottle.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_unthrottle.md new file mode 100644 index 000000000..429a601b5 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL_unthrottle.md @@ -0,0 +1,37 @@ +--- +title: OnlineDDL unthrottle +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) +``` + +### SEE ALSO + +* [vtctldclient OnlineDDL](./vtctldclient_onlineddl/) - Operates on online DDL (schema migrations). + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard.md new file mode 100644 index 000000000..91a4bd8f6 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard.md @@ -0,0 +1,39 @@ +--- +title: Reshard +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Reshard + +Perform commands related to resharding a keyspace. + +### Options + +``` + --format string The format of the output; supported formats are: text,json. (default "text") + -h, --help help for Reshard + --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) +``` + +### SEE ALSO + +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient Reshard cancel](./vtctldclient_reshard_cancel/) - Cancel a Reshard VReplication workflow. +* [vtctldclient Reshard complete](./vtctldclient_reshard_complete/) - Complete a Reshard VReplication workflow. +* [vtctldclient Reshard create](./vtctldclient_reshard_create/) - Create and optionally run a Reshard VReplication workflow. +* [vtctldclient Reshard reversetraffic](./vtctldclient_reshard_reversetraffic/) - Reverse traffic for a Reshard VReplication workflow. +* [vtctldclient Reshard show](./vtctldclient_reshard_show/) - Show the details for a Reshard VReplication workflow. +* [vtctldclient Reshard start](./vtctldclient_reshard_start/) - Start a Reshard workflow. +* [vtctldclient Reshard status](./vtctldclient_reshard_status/) - Show the current status for a Reshard VReplication workflow. +* [vtctldclient Reshard stop](./vtctldclient_reshard_stop/) - Stop a Reshard workflow. +* [vtctldclient Reshard switchtraffic](./vtctldclient_reshard_switchtraffic/) - Switch traffic for a Reshard VReplication workflow. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_cancel.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_cancel.md new file mode 100644 index 000000000..343e525a7 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_cancel.md @@ -0,0 +1,40 @@ +--- +title: Reshard cancel +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Reshard cancel + +Cancel a Reshard VReplication workflow. + +``` +vtctldclient Reshard cancel +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_complete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_complete.md new file mode 100644 index 000000000..3213c9a83 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_complete.md @@ -0,0 +1,40 @@ +--- +title: Reshard complete +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Reshard complete + +Complete a Reshard VReplication workflow. + +``` +vtctldclient Reshard complete +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_create.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_create.md new file mode 100644 index 000000000..a42fe22cc --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_create.md @@ -0,0 +1,51 @@ +--- +title: Reshard create +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Reshard create + +Create and optionally run a Reshard VReplication workflow. + +``` +vtctldclient Reshard create +``` + +### Examples + +``` +vtctldclient --server localhost:15999 reshard --workflow customer2customer --target-keyspace customer create --source-shards="0" --target-shards="-80,80-" --cells zone1 --cells zone2 --tablet-types replica +``` + +### Options + +``` + -a, --all-cells Copy table data from any existing cell. + --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. + -h, --help help for create + --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") + --skip-schema-copy Skip copying the schema from the source shards to the target shards. + --source-shards strings Source shards. + --stop-after-copy Stop the workflow after it's finished copying the existing rows and before it starts replicating changes. + --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) + --target-shards strings Target shards. +``` + +### 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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_reversetraffic.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_reversetraffic.md new file mode 100644 index 000000000..29d5c3d98 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_reversetraffic.md @@ -0,0 +1,46 @@ +--- +title: Reshard reversetraffic +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Reshard reversetraffic + +Reverse traffic for a Reshard VReplication workflow. + +``` +vtctldclient Reshard reversetraffic +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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) + --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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_show.md new file mode 100644 index 000000000..1fb27273b --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_show.md @@ -0,0 +1,41 @@ +--- +title: Reshard show +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Reshard show + +Show the details for a Reshard VReplication workflow. + +``` +vtctldclient Reshard show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_start.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_start.md new file mode 100644 index 000000000..e8e99834e --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_start.md @@ -0,0 +1,40 @@ +--- +title: Reshard start +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Reshard start + +Start a Reshard workflow. + +``` +vtctldclient Reshard start +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_status.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_status.md new file mode 100644 index 000000000..03dff5eeb --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_status.md @@ -0,0 +1,40 @@ +--- +title: Reshard status +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Reshard status + +Show the current status for a Reshard VReplication workflow. + +``` +vtctldclient Reshard status +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_stop.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_stop.md new file mode 100644 index 000000000..e22256528 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_stop.md @@ -0,0 +1,40 @@ +--- +title: Reshard stop +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Reshard stop + +Stop a Reshard workflow. + +``` +vtctldclient Reshard stop +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_switchtraffic.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_switchtraffic.md new file mode 100644 index 000000000..ac9f66977 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard_switchtraffic.md @@ -0,0 +1,46 @@ +--- +title: Reshard switchtraffic +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Reshard switchtraffic + +Switch traffic for a Reshard VReplication workflow. + +``` +vtctldclient Reshard switchtraffic +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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 + --max-replication-lag-allowed duration Allow traffic to be switched only if VReplication lag is below this. (default 30s) + --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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff.md new file mode 100644 index 000000000..76c0c355e --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff.md @@ -0,0 +1,35 @@ +--- +title: VDiff +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient VDiff + +Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + +### Options + +``` + --format string The format of the output; supported formats are: text,json. (default "text") + -h, --help help for VDiff + --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) +``` + +### SEE ALSO + +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient VDiff create](./vtctldclient_vdiff_create/) - Create and run a VDiff to compare the tables involved in a VReplication workflow between the source and target. +* [vtctldclient VDiff delete](./vtctldclient_vdiff_delete/) - Delete VDiffs. +* [vtctldclient VDiff resume](./vtctldclient_vdiff_resume/) - Resume a VDiff. +* [vtctldclient VDiff show](./vtctldclient_vdiff_show/) - Show the status of a VDiff. +* [vtctldclient VDiff stop](./vtctldclient_vdiff_stop/) - Stop a running VDiff. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_create.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_create.md new file mode 100644 index 000000000..8742baca0 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_create.md @@ -0,0 +1,55 @@ +--- +title: VDiff create +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient VDiff create + +Create and run a VDiff to compare the tables involved in a VReplication workflow between the source and target. + +``` +vtctldclient VDiff create +``` + +### Examples + +``` +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace customer create +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace customer create b3f59678-5241-11ee-be56-0242ac120002 +``` + +### Options + +``` + --auto-retry Should this vdiff automatically retry and continue in case of recoverable errors. (default true) + --debug-query Adds a mysql query to the report that can be used for further debugging. + --filtered-replication-wait-time duration Specifies the maximum time to wait, in seconds, for replication to catch up when syncing tablet streams. (default 30s) + -h, --help help for create + --limit int Max rows to stop comparing after. (default 9223372036854775807) + --max-extra-rows-to-compare int If there are collation differences between the source and target, you can have rows that are identical but simply returned in a different order from MySQL. We will do a second pass to compare the rows for any actual differences in this case and this flag allows you to control the resources used for this operation. (default 1000) + --only-pks When reporting missing rows, only show primary keys in the report. + --source-cells strings The source cell(s) to compare from; default is any available cell. + --tables strings Only run vdiff for these tables in the workflow. + --tablet-types strings Tablet types to use on the source and target. + --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) + --target-cells strings The target cell(s) to compare with; default is any available cell. + --update-table-stats Update the table statistics, using ANALYZE TABLE, on each table involved in the VDiff during initialization. This will ensure that progress estimates are as accurate as possible -- but it does involve locks and can potentially impact query processing on the target keyspace. + --wait When creating or resuming a vdiff, wait for it to finish before exiting. + --wait-update-interval duration When waiting on a vdiff to finish, check and display the current status this often. (default 1m0s) +``` + +### 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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient VDiff](./vtctldclient_vdiff/) - Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_delete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_delete.md new file mode 100644 index 000000000..17854ea29 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_delete.md @@ -0,0 +1,41 @@ +--- +title: VDiff delete +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient VDiff delete + +Delete VDiffs. + +``` +vtctldclient VDiff delete +``` + +### Examples + +``` +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace delete a037a9e2-5628-11ee-8c99-0242ac120002 +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace delete all +``` + +### Options + +``` + -h, --help help for 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 + --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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient VDiff](./vtctldclient_vdiff/) - Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_resume.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_resume.md new file mode 100644 index 000000000..466a3094b --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_resume.md @@ -0,0 +1,40 @@ +--- +title: VDiff resume +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient VDiff resume + +Resume a VDiff. + +``` +vtctldclient VDiff resume +``` + +### Examples + +``` +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace resume a037a9e2-5628-11ee-8c99-0242ac120002 +``` + +### Options + +``` + -h, --help help for resume +``` + +### 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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient VDiff](./vtctldclient_vdiff/) - Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_show.md new file mode 100644 index 000000000..672e17799 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_show.md @@ -0,0 +1,43 @@ +--- +title: VDiff show +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient VDiff show + +Show the status of a VDiff. + +``` +vtctldclient VDiff show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace show last +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace show a037a9e2-5628-11ee-8c99-0242ac120002 +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace show all +``` + +### Options + +``` + -h, --help help for show + --verbose Show verbose output in summaries +``` + +### 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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient VDiff](./vtctldclient_vdiff/) - Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_stop.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_stop.md new file mode 100644 index 000000000..87df9eca5 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_VDiff_stop.md @@ -0,0 +1,40 @@ +--- +title: VDiff stop +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient VDiff stop + +Stop a running VDiff. + +``` +vtctldclient VDiff stop +``` + +### Examples + +``` +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace stop a037a9e2-5628-11ee-8c99-0242ac120002 +``` + +### 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. + -w, --workflow string The workflow you want to perform the command on. +``` + +### SEE ALSO + +* [vtctldclient VDiff](./vtctldclient_vdiff/) - Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow.md new file mode 100644 index 000000000..4b7a60f01 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow.md @@ -0,0 +1,38 @@ +--- +title: Workflow +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Workflow + +Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + +``` +vtctldclient Workflow --keyspace [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) +``` + +### 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/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_delete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_delete.md new file mode 100644 index 000000000..87b2e8684 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_delete.md @@ -0,0 +1,41 @@ +--- +title: Workflow delete +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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. + -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) +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_list.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_list.md new file mode 100644 index 000000000..a22279b67 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_list.md @@ -0,0 +1,38 @@ +--- +title: Workflow list +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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 +``` + +### 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) +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_show.md new file mode 100644 index 000000000..0245c909f --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_show.md @@ -0,0 +1,40 @@ +--- +title: Workflow show +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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) + -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) +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_start.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_start.md new file mode 100644 index 000000000..a4b3770c3 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_start.md @@ -0,0 +1,39 @@ +--- +title: Workflow start +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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 + -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) +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_stop.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_stop.md new file mode 100644 index 000000000..f4eb92e56 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_stop.md @@ -0,0 +1,39 @@ +--- +title: Workflow stop +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## 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 + -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) +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_update.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_update.md new file mode 100644 index 000000000..a1ed2e2cc --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow_update.md @@ -0,0 +1,43 @@ +--- +title: Workflow update +series: vtctldclient +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff +--- +## vtctldclient Workflow update + +Update the configuration parameters for a VReplication workflow. + +``` +vtctldclient Workflow update +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer update --workflow commerce2customer --cells zone1 --cells zone2 -c "zone3,zone4" -c zone5 +``` + +### Options + +``` + -c, --cells strings New Cell(s) or CellAlias(es) (comma-separated) to replicate from. + -h, --help help for update + --on-ddl string New instruction on what to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE. + -t, --tablet-types strings New source tablet types to replicate from (e.g. PRIMARY,REPLICA,RDONLY). + --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) +``` + +### SEE ALSO + +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/18.0/reference/programs/zkctl/zkctl_init.md b/content/en/docs/18.0/reference/programs/zkctl/zkctl_init.md index 531025560..71967f72f 100644 --- a/content/en/docs/18.0/reference/programs/zkctl/zkctl_init.md +++ b/content/en/docs/18.0/reference/programs/zkctl/zkctl_init.md @@ -1,7 +1,7 @@ --- title: init series: zkctl -commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## 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) diff --git a/content/en/docs/18.0/reference/programs/zkctl/zkctl_shutdown.md b/content/en/docs/18.0/reference/programs/zkctl/zkctl_shutdown.md index ec709f531..639187d33 100644 --- a/content/en/docs/18.0/reference/programs/zkctl/zkctl_shutdown.md +++ b/content/en/docs/18.0/reference/programs/zkctl/zkctl_shutdown.md @@ -1,7 +1,7 @@ --- title: shutdown series: zkctl -commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## 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) diff --git a/content/en/docs/18.0/reference/programs/zkctl/zkctl_start.md b/content/en/docs/18.0/reference/programs/zkctl/zkctl_start.md index 63faf3a5f..33518751e 100644 --- a/content/en/docs/18.0/reference/programs/zkctl/zkctl_start.md +++ b/content/en/docs/18.0/reference/programs/zkctl/zkctl_start.md @@ -1,7 +1,7 @@ --- title: start series: zkctl -commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## 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) diff --git a/content/en/docs/18.0/reference/programs/zkctl/zkctl_teardown.md b/content/en/docs/18.0/reference/programs/zkctl/zkctl_teardown.md index 09a03ea37..2f04830d1 100644 --- a/content/en/docs/18.0/reference/programs/zkctl/zkctl_teardown.md +++ b/content/en/docs/18.0/reference/programs/zkctl/zkctl_teardown.md @@ -1,7 +1,7 @@ --- title: teardown series: zkctl -commit: aa72dc8d9189843c0a49f32b54f6fc978f6dbcde +commit: d3012c188ea0cfc6837917fc6642ea23be9bb1ff --- ## 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) 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 7ee95d315..70c53103e 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: 2642bea6b1d3476889564c49ed64829f2a3d0a90 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## 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 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 5feceae61..fca31c706 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: 2642bea6b1d3476889564c49ed64829f2a3d0a90 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## 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 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 f2f63df59..281ac6732 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: 2642bea6b1d3476889564c49ed64829f2a3d0a90 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## 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 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 28e1f13b2..692abbb1c 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: 2642bea6b1d3476889564c49ed64829f2a3d0a90 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## 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 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 b7f43c725..8658c930a 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: 2642bea6b1d3476889564c49ed64829f2a3d0a90 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## 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 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 ed618ef6a..3c408f6ba 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: 2642bea6b1d3476889564c49ed64829f2a3d0a90 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## 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 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 530d4b275..99978f6ff 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: 2642bea6b1d3476889564c49ed64829f2a3d0a90 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## 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 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 e0e6c2b9f..5902ff821 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: 20b1e461f3710f368a04eb0b563fd3de3df56908 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## vtbackup @@ -220,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/vtcombo/_index.md b/content/en/docs/19.0/reference/programs/vtcombo/_index.md index 854755705..3e0b1ddb6 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: a85c612dc9a58aa2e4b13010fdba99e246646618 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## vtcombo @@ -357,7 +357,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 a4d418d64..22686adf9 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: a85c612dc9a58aa2e4b13010fdba99e246646618 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## vtctld @@ -156,7 +156,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_LookupVindex.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md new file mode 100644 index 000000000..8689bc27b --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md @@ -0,0 +1,36 @@ +--- +title: LookupVindex +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..99d06a574 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..ce8176edd --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..f267d038b --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..0774bf6b4 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..39d94b76b --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize.md @@ -0,0 +1,38 @@ +--- +title: Materialize +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..1c0d3ef0e --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..afb2d8033 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..e3e56eff3 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..61db53d5b --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..45161a0ed --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..4159ac7f9 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate.md @@ -0,0 +1,38 @@ +--- +title: Migrate +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..899a1cf8a --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..10ad3c911 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..64ebbbea2 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..67349b16f --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..180d7fd42 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..0bd85f883 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Mount.md @@ -0,0 +1,34 @@ +--- +title: Mount +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..567a697d9 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..64861c622 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..d6d9d4f75 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..a2aadf773 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..d07ee81f4 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_MoveTables.md @@ -0,0 +1,42 @@ +--- +title: MoveTables +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..6edd6566e --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..902ff58e9 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..7908967a3 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..6cbae2476 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..51a5336c9 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..94b6742e1 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..522ca0f64 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..c2357a91e --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..386c2284f --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..7dc698887 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL.md @@ -0,0 +1,39 @@ +--- +title: OnlineDDL +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..4748cf845 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..a58ba941e --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..d3337e134 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..09070f7c2 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..5fac737f6 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..d10f566b0 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..558dba52f --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..2e84030f1 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..e9d61dc91 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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_Reshard.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard.md new file mode 100644 index 000000000..4ec47d65f --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard.md @@ -0,0 +1,42 @@ +--- +title: Reshard +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient Reshard + +Perform commands related to resharding a keyspace. + +### Options + +``` + --format string The format of the output; supported formats are: text,json. (default "text") + -h, --help help for Reshard + --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 Reshard cancel](./vtctldclient_reshard_cancel/) - Cancel a Reshard VReplication workflow. +* [vtctldclient Reshard complete](./vtctldclient_reshard_complete/) - Complete a Reshard VReplication workflow. +* [vtctldclient Reshard create](./vtctldclient_reshard_create/) - Create and optionally run a Reshard VReplication workflow. +* [vtctldclient Reshard reversetraffic](./vtctldclient_reshard_reversetraffic/) - Reverse traffic for a Reshard VReplication workflow. +* [vtctldclient Reshard show](./vtctldclient_reshard_show/) - Show the details for a Reshard VReplication workflow. +* [vtctldclient Reshard start](./vtctldclient_reshard_start/) - Start a Reshard workflow. +* [vtctldclient Reshard status](./vtctldclient_reshard_status/) - Show the current status for a Reshard VReplication workflow. +* [vtctldclient Reshard stop](./vtctldclient_reshard_stop/) - Stop a Reshard workflow. +* [vtctldclient Reshard switchtraffic](./vtctldclient_reshard_switchtraffic/) - Switch traffic for a Reshard VReplication workflow. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_cancel.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_cancel.md new file mode 100644 index 000000000..74169cddb --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_cancel.md @@ -0,0 +1,43 @@ +--- +title: Reshard cancel +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient Reshard cancel + +Cancel a Reshard VReplication workflow. + +``` +vtctldclient Reshard cancel +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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 Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_complete.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_complete.md new file mode 100644 index 000000000..4df1c0768 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_complete.md @@ -0,0 +1,43 @@ +--- +title: Reshard complete +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient Reshard complete + +Complete a Reshard VReplication workflow. + +``` +vtctldclient Reshard complete +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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 Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_create.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_create.md new file mode 100644 index 000000000..2809ace3e --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_create.md @@ -0,0 +1,54 @@ +--- +title: Reshard create +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient Reshard create + +Create and optionally run a Reshard VReplication workflow. + +``` +vtctldclient Reshard create +``` + +### Examples + +``` +vtctldclient --server localhost:15999 reshard --workflow customer2customer --target-keyspace customer create --source-shards="0" --target-shards="-80,80-" --cells zone1 --cells zone2 --tablet-types replica +``` + +### Options + +``` + -a, --all-cells Copy table data from any existing cell. + --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. + -h, --help help for create + --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") + --skip-schema-copy Skip copying the schema from the source shards to the target shards. + --source-shards strings Source shards. + --stop-after-copy Stop the workflow after it's finished copying the existing rows and before it starts replicating changes. + --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) + --target-shards strings Target shards. +``` + +### 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 Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_reversetraffic.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_reversetraffic.md new file mode 100644 index 000000000..321fc3b09 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_reversetraffic.md @@ -0,0 +1,49 @@ +--- +title: Reshard reversetraffic +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient Reshard reversetraffic + +Reverse traffic for a Reshard VReplication workflow. + +``` +vtctldclient Reshard reversetraffic +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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) + --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 Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_show.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_show.md new file mode 100644 index 000000000..7db51fd1d --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_show.md @@ -0,0 +1,44 @@ +--- +title: Reshard show +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient Reshard show + +Show the details for a Reshard VReplication workflow. + +``` +vtctldclient Reshard show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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 Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_start.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_start.md new file mode 100644 index 000000000..ac56c7b34 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_start.md @@ -0,0 +1,43 @@ +--- +title: Reshard start +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient Reshard start + +Start a Reshard workflow. + +``` +vtctldclient Reshard start +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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 Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_status.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_status.md new file mode 100644 index 000000000..06d3d9c3f --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_status.md @@ -0,0 +1,43 @@ +--- +title: Reshard status +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient Reshard status + +Show the current status for a Reshard VReplication workflow. + +``` +vtctldclient Reshard status +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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 Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_stop.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_stop.md new file mode 100644 index 000000000..e737bca4b --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_stop.md @@ -0,0 +1,43 @@ +--- +title: Reshard stop +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient Reshard stop + +Stop a Reshard workflow. + +``` +vtctldclient Reshard stop +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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 Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_switchtraffic.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_switchtraffic.md new file mode 100644 index 000000000..07655f410 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Reshard_switchtraffic.md @@ -0,0 +1,49 @@ +--- +title: Reshard switchtraffic +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient Reshard switchtraffic + +Switch traffic for a Reshard VReplication workflow. + +``` +vtctldclient Reshard switchtraffic +``` + +### Examples + +``` +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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 + --max-replication-lag-allowed duration Allow traffic to be switched only if VReplication lag is below this. (default 30s) + --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 Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff.md new file mode 100644 index 000000000..94a3351f1 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff.md @@ -0,0 +1,38 @@ +--- +title: VDiff +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient VDiff + +Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + +### Options + +``` + --format string The format of the output; supported formats are: text,json. (default "text") + -h, --help help for VDiff + --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 VDiff create](./vtctldclient_vdiff_create/) - Create and run a VDiff to compare the tables involved in a VReplication workflow between the source and target. +* [vtctldclient VDiff delete](./vtctldclient_vdiff_delete/) - Delete VDiffs. +* [vtctldclient VDiff resume](./vtctldclient_vdiff_resume/) - Resume a VDiff. +* [vtctldclient VDiff show](./vtctldclient_vdiff_show/) - Show the status of a VDiff. +* [vtctldclient VDiff stop](./vtctldclient_vdiff_stop/) - Stop a running VDiff. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_create.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_create.md new file mode 100644 index 000000000..0769f7a66 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_create.md @@ -0,0 +1,60 @@ +--- +title: VDiff create +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient VDiff create + +Create and run a VDiff to compare the tables involved in a VReplication workflow between the source and target. + +``` +vtctldclient VDiff create +``` + +### Examples + +``` +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace customer create +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace customer create b3f59678-5241-11ee-be56-0242ac120002 +``` + +### Options + +``` + --auto-retry Should this vdiff automatically retry and continue in case of recoverable errors. (default true) + --debug-query Adds a mysql query to the report that can be used for further debugging. + --filtered-replication-wait-time duration Specifies the maximum time to wait, in seconds, for replication to catch up when syncing tablet streams. (default 30s) + -h, --help help for create + --limit int Max rows to stop comparing after. (default 9223372036854775807) + --max-diff-duration duration How long should an individual table diff run before being stopped and restarted in order to lessen the impact on tablets due to holding open database snapshots for long periods of time (0 is the default and means no time limit). + --max-extra-rows-to-compare int If there are collation differences between the source and target, you can have rows that are identical but simply returned in a different order from MySQL. We will do a second pass to compare the rows for any actual differences in this case and this flag allows you to control the resources used for this operation. (default 1000) + --max-report-sample-rows int Maximum number of row differences to report (0 for all differences). NOTE: when increasing this value it is highly recommended to also specify --only-pks (default 10) + --only-pks When reporting missing rows, only show primary keys in the report. + --source-cells strings The source cell(s) to compare from; default is any available cell. + --tables strings Only run vdiff for these tables in the workflow. + --tablet-types strings Tablet types to use on the source and target. + --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) + --target-cells strings The target cell(s) to compare with; default is any available cell. + --update-table-stats Update the table statistics, using ANALYZE TABLE, on each table involved in the VDiff during initialization. This will ensure that progress estimates are as accurate as possible -- but it does involve locks and can potentially impact query processing on the target keyspace. + --wait When creating or resuming a vdiff, wait for it to finish before exiting. + --wait-update-interval duration When waiting on a vdiff to finish, check and display the current status this often. (default 1m0s) +``` + +### 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 VDiff](./vtctldclient_vdiff/) - Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_delete.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_delete.md new file mode 100644 index 000000000..31581b96f --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_delete.md @@ -0,0 +1,44 @@ +--- +title: VDiff delete +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient VDiff delete + +Delete VDiffs. + +``` +vtctldclient VDiff delete +``` + +### Examples + +``` +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace delete a037a9e2-5628-11ee-8c99-0242ac120002 +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace delete all +``` + +### Options + +``` + -h, --help help for 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 + --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 VDiff](./vtctldclient_vdiff/) - Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_resume.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_resume.md new file mode 100644 index 000000000..fb89087b9 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_resume.md @@ -0,0 +1,43 @@ +--- +title: VDiff resume +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient VDiff resume + +Resume a VDiff. + +``` +vtctldclient VDiff resume +``` + +### Examples + +``` +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace resume a037a9e2-5628-11ee-8c99-0242ac120002 +``` + +### Options + +``` + -h, --help help for resume +``` + +### 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 VDiff](./vtctldclient_vdiff/) - Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_show.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_show.md new file mode 100644 index 000000000..67e103ae7 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_show.md @@ -0,0 +1,46 @@ +--- +title: VDiff show +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient VDiff show + +Show the status of a VDiff. + +``` +vtctldclient VDiff show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace show last +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace show a037a9e2-5628-11ee-8c99-0242ac120002 +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace show all +``` + +### Options + +``` + -h, --help help for show + --verbose Show verbose output in summaries +``` + +### 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 VDiff](./vtctldclient_vdiff/) - Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_stop.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_stop.md new file mode 100644 index 000000000..a2b424092 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_VDiff_stop.md @@ -0,0 +1,43 @@ +--- +title: VDiff stop +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient VDiff stop + +Stop a running VDiff. + +``` +vtctldclient VDiff stop +``` + +### Examples + +``` +vtctldclient --server localhost:15999 vdiff --workflow commerce2customer --target-keyspace stop a037a9e2-5628-11ee-8c99-0242ac120002 +``` + +### 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 VDiff](./vtctldclient_vdiff/) - Perform commands related to diffing tables involved in a VReplication workflow between the source and target. + diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow.md new file mode 100644 index 000000000..69740e5a8 --- /dev/null +++ b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Workflow.md @@ -0,0 +1,41 @@ +--- +title: Workflow +series: vtctldclient +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## vtctldclient Workflow + +Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + +``` +vtctldclient Workflow --keyspace [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..fb20bef93 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..17ef77763 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..7dcb7f9ec --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..0d9bde7f7 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..a73ba8853 --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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..ff38029be --- /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: 38cfa19c590c23bc5b13af7614482f8d1b87efba +--- +## 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/vtorc/_index.md b/content/en/docs/19.0/reference/programs/vtorc/_index.md index 1b0c3cfe9..5333ec449 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: a85c612dc9a58aa2e4b13010fdba99e246646618 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## vtorc @@ -94,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 f2afbf587..76d451133 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: a85c612dc9a58aa2e4b13010fdba99e246646618 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## vttablet @@ -368,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 28583a793..f6c827800 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: a85c612dc9a58aa2e4b13010fdba99e246646618 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## vttestserver @@ -129,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/zkctl_init.md b/content/en/docs/19.0/reference/programs/zkctl/zkctl_init.md index 218664de7..a34068f7c 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: 2642bea6b1d3476889564c49ed64829f2a3d0a90 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## 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) 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 c71eb6063..c5aac098c 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: 2642bea6b1d3476889564c49ed64829f2a3d0a90 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## 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) 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 4c32144e3..d0a58db21 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: 2642bea6b1d3476889564c49ed64829f2a3d0a90 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## 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) 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 d7cd6ca00..65baf0a98 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: 2642bea6b1d3476889564c49ed64829f2a3d0a90 +commit: 38cfa19c590c23bc5b13af7614482f8d1b87efba --- ## 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)