mysqlctlclient

Documentation

Overview

Package mysqlctlclient contains the generic client side of the remote mysqlctl protocol.

Index

• func RegisterFactory(name string, factory Factory)
• type Factory
• type MysqlctlClient
  • func New(network, addr string) (MysqlctlClient, error)

Functions

func RegisterFactory

func RegisterFactory(name string, factory Factory)

RegisterFactory allows a client implementation to register itself

Types

type Factory

type Factory func(network, addr string, dialTimeout time.Duration) (MysqlctlClient, error)

Factory functions are registered by client implementations.

type MysqlctlClient

type MysqlctlClient interface {
	// Start calls Mysqld.Start remotely.
	Start(ctx context.Context) error

	// Shutdown calls Mysqld.Shutdown remotely.
	Shutdown(ctx context.Context, waitForMysqld bool) error

	// RunMysqlUpgrade calls Mysqld.RunMysqlUpgrade remotely.
	RunMysqlUpgrade(ctx context.Context) error

	// Close will terminate the connection. This object won't be used anymore.
	Close()
}

MysqlctlClient defines the interface used to send remote mysqlctl commands

func New

func New(network, addr string) (MysqlctlClient, error)

New creates a client implementation as specified by a flag.