cluster

Documentation

Index

• type Cluster
  • func (cluster *Cluster) IsRunning(ctx context.Context, node string) bool
  • func (cluster *Cluster) Kill(ctx context.Context, node string) error
  • func (cluster *Cluster) Name() string
  • func (cluster *Cluster) SetUp(ctx context.Context, nodes []string, node string) error
  • func (cluster *Cluster) Start(ctx context.Context, node string) error
  • func (cluster *Cluster) Stop(ctx context.Context, node string) error
  • func (cluster *Cluster) TearDown(ctx context.Context, nodes []string, node string) error

Types

type Cluster

type Cluster struct {
	IncludeTidb bool
	// contains filtered or unexported fields
}

Cluster is the TiKV/TiDB database cluster. Note: Cluster does not implement `core.DB` interface.

func (*Cluster) IsRunning

func (cluster *Cluster) IsRunning(ctx context.Context, node string) bool

IsRunning checks whether the database is running or not

func (*Cluster) Kill

func (cluster *Cluster) Kill(ctx context.Context, node string) error

Kill kills the database

func (*Cluster) Name

func (cluster *Cluster) Name() string

Name returns the unique name for the database

func (*Cluster) SetUp

func (cluster *Cluster) SetUp(ctx context.Context, nodes []string, node string) error

SetUp initializes the database.

func (*Cluster) Start

func (cluster *Cluster) Start(ctx context.Context, node string) error

Start starts the database

func (*Cluster) Stop

func (cluster *Cluster) Stop(ctx context.Context, node string) error

Stop stops the database

func (*Cluster) TearDown

func (cluster *Cluster) TearDown(ctx context.Context, nodes []string, node string) error

TearDown tears down the database.