github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/dm/ctl/master/pause_task.go (about)

     1  // Copyright 2019 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package master
    15  
    16  import (
    17  	"github.com/pingcap/tiflow/dm/pb"
    18  	"github.com/spf13/cobra"
    19  )
    20  
    21  // NewPauseTaskCmd creates a PauseTask command.
    22  func NewPauseTaskCmd() *cobra.Command {
    23  	cmd := &cobra.Command{
    24  		Use:   `pause-task [-s source ...] [task-name | task-file]`,
    25  		Short: "Pauses a specified running task or all (sub)tasks bound to a source",
    26  		RunE:  pauseTaskFunc,
    27  	}
    28  	addOperateSourceTaskFlags(cmd)
    29  	return cmd
    30  }
    31  
    32  // pauseTaskFunc does pause task request.
    33  func pauseTaskFunc(cmd *cobra.Command, _ []string) (err error) {
    34  	return operateTaskFunc(pb.TaskOp_Pause, cmd)
    35  }