client

Documentation

Index

• func BatchCallCmd(nodes []*util.PegasusNode, cmd string, args []string) map[*util.PegasusNode]*CmdResult
• func DowngradeNode(meta Meta, node *util.PegasusNode) error
• func DowngradeNodeWithDetails(meta Meta, node *util.PegasusNode) ([]*base.Gpid, error)
• func ListPrimariesOnNode(meta Meta, node *util.PegasusNode, tableName string) ([]*replication.PartitionConfiguration, error)
• func MigratePrimariesOut(meta Meta, node *util.PegasusNode) error
• func SetMetaLevelLively(meta Meta) error
• func SetMetaLevelSteady(meta Meta) error
• func SetRPCTimeout(d time.Duration)
• type BalanceType
  • func (t BalanceType) String() string
• type ClusterReplicaInfo
  • func GetClusterReplicaInfo(meta Meta) (*ClusterReplicaInfo, error)
• type CmdResult
  • func CallCmd(n *util.PegasusNode, cmd string, args []string) *CmdResult
  • func (c *CmdResult) Error() error
  • func (c *CmdResult) Failed() bool
  • func (c *CmdResult) RespBody() string
  • func (c *CmdResult) String() string
• type Meta
  • func NewRPCBasedMeta(metaAddrs []string) Meta
• type NodeState
  • func ListNodesReplicaInfo(meta Meta) ([]*NodeState, error)
• type TableHealthInfo
  • func GetTableHealthInfo(meta Meta, tableName string) (*TableHealthInfo, error)

Functions

func BatchCallCmd

func BatchCallCmd(nodes []*util.PegasusNode, cmd string, args []string) map[*util.PegasusNode]*CmdResult

BatchCallCmd performs remote commands in parallel to multiple nodes.

func DowngradeNode

func DowngradeNode(meta Meta, node *util.PegasusNode) error

DowngradeNode sets all secondaries from the specified node to inactive state. NOTE: this step requires that the node has no primary, otherwise error is returned.

func DowngradeNodeWithDetails

func DowngradeNodeWithDetails(meta Meta, node *util.PegasusNode) ([]*base.Gpid, error)

DowngradeNodeWithDetails is like DowngradeNode but also returns the partitions that were downgraded.

func ListPrimariesOnNode

func ListPrimariesOnNode(meta Meta, node *util.PegasusNode, tableName string) ([]*replication.PartitionConfiguration, error)

func MigratePrimariesOut

func MigratePrimariesOut(meta Meta, node *util.PegasusNode) error

MigratePrimariesOut migrates all primaries out from the specified node. Internally, for every partition it merely swaps the roles of primary and secondary, so it incurs no data migration. Eventually, the node will have no primaries because they are all turned to secondaries.

func SetMetaLevelLively

func SetMetaLevelLively(meta Meta) error

func SetMetaLevelSteady

func SetMetaLevelSteady(meta Meta) error

func SetRPCTimeout

func SetRPCTimeout(d time.Duration)

SetRPCTimeout is the global timeout setting of RPC.

Types

type BalanceType

type BalanceType int

const (
	BalanceMovePri BalanceType = iota
	BalanceCopyPri
	BalanceCopySec
)

func (BalanceType) String

func (t BalanceType) String() string

type ClusterReplicaInfo

type ClusterReplicaInfo struct {
	Tables []*TableHealthInfo
	Nodes  []*NodeState
}

ClusterReplicaInfo is a report of the replicas distributed in the cluster.

func GetClusterReplicaInfo

func GetClusterReplicaInfo(meta Meta) (*ClusterReplicaInfo, error)

GetClusterReplicaInfo returns replica info in both node and table perspectives. = From node perspective, it returns a list of node states, each contains the replica details, including those with no replicas (empty node). = From table perspective, it returns a list of table states, each contains the partition health information.

type CmdResult

type CmdResult struct {
	// contains filtered or unexported fields
}

CmdResult is the result of remote command to a node.

func CallCmd

func CallCmd(n *util.PegasusNode, cmd string, args []string) *CmdResult

CallCmd calls remote command to a single node.

func (*CmdResult) Error

func (c *CmdResult) Error() error

func (*CmdResult) Failed

func (c *CmdResult) Failed() bool

func (*CmdResult) RespBody

func (c *CmdResult) RespBody() string

func (*CmdResult) String

func (c *CmdResult) String() string

type Meta

type Meta interface {
	Close() error

	// ListAvailableApps lists only available tables.
	ListAvailableApps() ([]*admin.AppInfo, error)

	ListApps(status admin.AppStatus) ([]*admin.AppInfo, error)

	QueryConfig(tableName string) (*replication.QueryCfgResponse, error)

	MetaControl(level admin.MetaFunctionLevel) (oldLevel admin.MetaFunctionLevel, err error)

	QueryClusterInfo() (map[string]string, error)

	UpdateAppEnvs(tableName string, envs map[string]string) error

	ClearAppEnvs(tableName string, clearPrefix string) error

	DelAppEnvs(tableName string, keys []string) error

	CreateApp(tableName string, envs map[string]string, partitionCount int) (int32, error)

	DropApp(tableName string, reserveSeconds int64) error

	ModifyDuplication(tableName string, dupid int, status admin.DuplicationStatus) error

	AddDuplication(tableName string, remoteCluster string, freezed bool) (*admin.DuplicationAddResponse, error)

	QueryDuplication(tableName string) (*admin.DuplicationQueryResponse, error)

	ListNodes() ([]*admin.NodeInfo, error)

	RecallApp(originTableID int, newTableName string) (*admin.AppInfo, error)

	Balance(gpid *base.Gpid, opType BalanceType, from *util.PegasusNode, to *util.PegasusNode) error

	Propose(gpid *base.Gpid, action admin.ConfigType, target *util.PegasusNode, node *util.PegasusNode) error

	StartBackupApp(tableID int, providerType string, backupPath string) (*admin.StartBackupAppResponse, error)

	QueryBackupStatus(tableID int, backupID int64) (*admin.QueryBackupStatusResponse, error)

	RestoreApp(oldClusterName string, oldTableName string, oldTableID int, backupID int64, providerType string,
		newTableName string, restorePath string, skipBadPartition bool, policyName string) (*admin.CreateAppResponse, error)

	StartPartitionSplit(tableName string, newPartitionCount int) error

	QuerySplitStatus(tableName string) (*admin.QuerySplitResponse, error)

	PausePartitionSplit(tableName string, parentPidx int) error

	RestartPartitionSplit(tableName string, parentPidx int) error

	CancelPartitionSplit(tableName string, oldPartitionCount int) error

	StartBulkLoad(tableName string, clusterName string, providerType string, rootPath string) error

	QueryBulkLoad(tableName string) (*admin.QueryBulkLoadResponse, error)

	PauseBulkLoad(tableName string) error

	RestartBulkLoad(tableName string) error

	CancelBulkLoad(tableName string, forced bool) error

	StartManualCompaction(tableName string, targetLevel int, maxRunningCount int, bottommost bool) error

	QueryManualCompaction(tableName string) (*admin.QueryAppManualCompactResponse, error)
}

Meta is a helper over pegasus-go-client's primitive session.MetaManager. It aims to provide an easy-to-use API that eliminates some boilerplate code, like context creation, request/response creation, etc.

func NewRPCBasedMeta

func NewRPCBasedMeta(metaAddrs []string) Meta

NewRPCBasedMeta creates the connection to meta.

type NodeState

type NodeState struct {
	IPPort string

	Status admin.NodeStatus

	PrimariesNum   int
	SecondariesNum int
	ReplicaCount   int
}

func ListNodesReplicaInfo

func ListNodesReplicaInfo(meta Meta) ([]*NodeState, error)

ListNodesReplicaInfo returns how replicas distributed among nodes.

type TableHealthInfo

type TableHealthInfo struct {
	PartitionCount int32
	Unhealthy      int32
	WriteUnhealthy int32
	ReadUnhealthy  int32
	FullHealthy    int32
}

TableHealthInfo is a report of replica health within the table.

func GetTableHealthInfo

func GetTableHealthInfo(meta Meta, tableName string) (*TableHealthInfo, error)

GetTableHealthInfo return *TableHealthInfo from meta.