Update more docs to refer to `Reshard`/`MoveTables`

Signed-off-by: Andrew Mason <amason@slack-corp.com>
This commit is contained in:
Andrew Mason 2021-09-23 18:42:49 -04:00
Родитель 685c221f91
Коммит bc22ac063c
5 изменённых файлов: 18 добавлений и 16 удалений

Просмотреть файл

@ -340,8 +340,8 @@ func init() {
Root.AddCommand(SetShardIsPrimaryServing)
SetShardTabletControl.Flags().StringSliceVarP(&setShardTabletControlOptions.Cells, "cells", "c", nil, "Specifies a comma-separated list of cells to update.")
SetShardTabletControl.Flags().StringSliceVar(&setShardTabletControlOptions.DeniedTables, "denied-tables", nil, "Specifies a comma-separated list of tables to add to the denylist (for vertical splits). Each table name is either an exact match, or a regular expression of the form '/regexp/'.")
SetShardTabletControl.Flags().BoolVarP(&setShardTabletControlOptions.Remove, "remove", "r", false, "Removes the specified cells for vertical splits.")
SetShardTabletControl.Flags().StringSliceVar(&setShardTabletControlOptions.DeniedTables, "denied-tables", nil, "Specifies a comma-separated list of tables to add to the denylist (for MoveTables). Each table name is either an exact match, or a regular expression of the form '/regexp/'.")
SetShardTabletControl.Flags().BoolVarP(&setShardTabletControlOptions.Remove, "remove", "r", false, "Removes the specified cells for MoveTables operations.")
SetShardTabletControl.Flags().BoolVar(&setShardTabletControlOptions.DisableQueryService, "disable-query-service", false, "Sets the DisableQueryService flag in the specified cells. This flag requires --denied-tables and --remove to be unset; if either is set, this flag is ignored.")
Root.AddCommand(SetShardTabletControl)

Просмотреть файл

@ -5254,19 +5254,20 @@ type SetShardTabletControlRequest struct {
Cells []string `protobuf:"bytes,4,rep,name=cells,proto3" json:"cells,omitempty"`
// DeniedTables updates the list of denied tables the shard will serve for
// the given tablet type. This is useful to fix tables that are being blocked
// after a vertical split.
// after a MoveTables operation.
//
// NOTE: Setting this field will cause DisableQueryService to be ignored.
DeniedTables []string `protobuf:"bytes,5,rep,name=denied_tables,json=deniedTables,proto3" json:"denied_tables,omitempty"`
// DisableQueryService instructs whether to enable the query service on
// tablets of the given type in the shard. This is useful to fix horizontal
// splits gone awry.
// tablets of the given type in the shard. This is useful to fix Reshard
// operations gone awry.
//
// NOTE: this is ignored if DeniedTables is not empty.
DisableQueryService bool `protobuf:"varint,6,opt,name=disable_query_service,json=disableQueryService,proto3" json:"disable_query_service,omitempty"`
// Remove removes the ShardTabletControl record entirely. If set, this takes
// precedence over DeniedTables and DisableQueryService fields, and is useful
// to manually remove serving restrictions after a completed vertical split.
// to manually remove serving restrictions after a completed MoveTables
// operation.
Remove bool `protobuf:"varint,7,opt,name=remove,proto3" json:"remove,omitempty"`
}

Просмотреть файл

@ -273,8 +273,8 @@ type VtctldClient interface {
// tablet type.
//
// This should only be used for an emergency fix, or after a finished
// vertical split. See the documentation on SetShardTabletControlRequest for
// more information about the different update modes.
// Reshard. See the documentation on SetShardTabletControlRequest for more
// information about the different update modes.
SetShardTabletControl(ctx context.Context, in *vtctldata.SetShardTabletControlRequest, opts ...grpc.CallOption) (*vtctldata.SetShardTabletControlResponse, error)
// SetWritable sets a tablet as read-write (writable=true) or read-only (writable=false).
SetWritable(ctx context.Context, in *vtctldata.SetWritableRequest, opts ...grpc.CallOption) (*vtctldata.SetWritableResponse, error)
@ -931,8 +931,8 @@ type VtctldServer interface {
// tablet type.
//
// This should only be used for an emergency fix, or after a finished
// vertical split. See the documentation on SetShardTabletControlRequest for
// more information about the different update modes.
// Reshard. See the documentation on SetShardTabletControlRequest for more
// information about the different update modes.
SetShardTabletControl(context.Context, *vtctldata.SetShardTabletControlRequest) (*vtctldata.SetShardTabletControlResponse, error)
// SetWritable sets a tablet as read-write (writable=true) or read-only (writable=false).
SetWritable(context.Context, *vtctldata.SetWritableRequest) (*vtctldata.SetWritableResponse, error)

Просмотреть файл

@ -730,19 +730,20 @@ message SetShardTabletControlRequest {
repeated string cells = 4;
// DeniedTables updates the list of denied tables the shard will serve for
// the given tablet type. This is useful to fix tables that are being blocked
// after a vertical split.
// after a MoveTables operation.
//
// NOTE: Setting this field will cause DisableQueryService to be ignored.
repeated string denied_tables = 5;
// DisableQueryService instructs whether to enable the query service on
// tablets of the given type in the shard. This is useful to fix horizontal
// splits gone awry.
// tablets of the given type in the shard. This is useful to fix Reshard
// operations gone awry.
//
// NOTE: this is ignored if DeniedTables is not empty.
bool disable_query_service = 6;
// Remove removes the ShardTabletControl record entirely. If set, this takes
// precedence over DeniedTables and DisableQueryService fields, and is useful
// to manually remove serving restrictions after a completed vertical split.
// to manually remove serving restrictions after a completed MoveTables
// operation.
bool remove = 7;
}

Просмотреть файл

@ -172,8 +172,8 @@ service Vtctld {
// tablet type.
//
// This should only be used for an emergency fix, or after a finished
// vertical split. See the documentation on SetShardTabletControlRequest for
// more information about the different update modes.
// Reshard. See the documentation on SetShardTabletControlRequest for more
// information about the different update modes.
rpc SetShardTabletControl(vtctldata.SetShardTabletControlRequest) returns (vtctldata.SetShardTabletControlResponse) {};
// SetWritable sets a tablet as read-write (writable=true) or read-only (writable=false).
rpc SetWritable(vtctldata.SetWritableRequest) returns (vtctldata.SetWritableResponse) {};