ctl

Documentation

Index

• Variables
• func GetTNHandlerFunc(method api.OpCode, whichTN func(parameter string) ([]uint64, error), ...) handleFunc
• func IsValidArg(parameter string, proc *process.Process) (*db.DiskCleaner, error)
• func MoCtl(ivecs []*vector.Vector, result vector.FunctionResultWrapper, ...) error
• func SelfProcess(cmd string, spans string, threshold int64) string
• type Result

Variables

var (
	PingMethod             = "PING"
	FlushMethod            = "FLUSH"
	TaskMethod             = "TASK"
	UseSnapshotMethod      = "USESNAPSHOT"
	GetSnapshotMethod      = "GETSNAPSHOT"
	CheckpointMethod       = "CHECKPOINT"
	GlobalCheckpointMethod = "GLOBALCHECKPOINT"
	ForceGCMethod          = "FORCEGC"
	InspectMethod          = "INSPECT"
	LabelMethod            = "LABEL"
	WorkStateMethod        = "WORKSTATE"
	SyncCommitMethod       = "SYNCCOMMIT"
	AddFaultPointMethod    = "ADDFAULTPOINT"
	BackupMethod           = "BACKUP"
	TraceSpanMethod        = "TRACESPAN"
	CoreDumpMethod         = "COREDUMP"
	InterceptCommitMethod  = "INTERCEPTCOMMIT"
	MergeObjectsMethod     = "MERGEOBJECTS"
	DisableCKPMethod       = "DISABLECKP"
	DiskCleanerMethod      = "DISKCLEANER"

	GetProtocolVersionMethod = "GETPROTOCOLVERSION"
	SetProtocolVersionMethod = "SETPROTOCOLVERSION"

	RemoveRemoteLockTable = strings.ToUpper("RemoveRemoteLockTable")
	GetLatestBind         = strings.ToUpper("GetLatestBind")
	UnsubscribeTable      = "UNSUBSCRIBE_TABLE"

	HandleTxnTrace = strings.ToUpper("txn-trace")

	ReloadAutoIncrementCache = strings.ToUpper("reload-auto-increment-cache")
)

var MoCtlTNCmdSender = func(ctx context.Context, proc *process.Process, requests []txn.CNOpRequest) ([]txn.CNOpResponse, error) {
	txnOp := proc.TxnOperator
	if txnOp == nil {
		return nil, moerr.NewInternalError(ctx, "ctl: txn operator is nil")
	}

	debugRequests := make([]txn.TxnRequest, 0, len(requests))
	for _, req := range requests {
		tq := txn.NewTxnRequest(&req)
		tq.Method = txn.TxnMethod_DEBUG
		debugRequests = append(debugRequests, tq)
	}
	result, err := txnOp.Debug(ctx, debugRequests)
	if err != nil {
		return nil, err
	}
	defer result.Release()

	responses := make([]txn.CNOpResponse, 0, len(requests))
	for _, resp := range result.Responses {
		responses = append(responses, *resp.CNOpResponse)
	}
	return responses, nil
}

Functions

func GetTNHandlerFunc

func GetTNHandlerFunc(method api.OpCode,
	whichTN func(parameter string) ([]uint64, error),
	payload func(tnShardID uint64, parameter string, proc *process.Process) ([]byte, error),
	repsonseUnmarshaler func([]byte) (any, error)) handleFunc

GetTNHandlerFunc used to handle dn's debug command handle func. method: debug command type. whichDN: used to decide which DNs to send the debug request to, nil returned means send all dns. payload: used to get debug command request payload repsonseUnmarshaler: used to unmarshal response

func IsValidArg

func IsValidArg(parameter string, proc *process.Process) (*db.DiskCleaner, error)

func MoCtl

func MoCtl(ivecs []*vector.Vector, result vector.FunctionResultWrapper, proc *process.Process, length int) error

mo_ctl functions are significantly different from oridinary functions and deserve its own package.

func SelfProcess

func SelfProcess(cmd string, spans string, threshold int64) string

Types

type Result

type Result struct {
	Method string `json:"method"`
	Data   any    `json:"result"`
}

Result ctl result