binlogreplication

Documentation

Index

• Constants
• type BinlogPrimaryCatalog
• type BinlogPrimaryController
• type BinlogReplicaCatalog
• type BinlogReplicaController
• type IntegerReplicationOptionValue
  • func (ov IntegerReplicationOptionValue) GetValue() interface{}
  • func (ov IntegerReplicationOptionValue) GetValueAsInt() int
  • func (ov IntegerReplicationOptionValue) String() string
• type ReplicaStatus
• type ReplicationOption
  • func NewReplicationOption(name string, value ReplicationOptionValue) *ReplicationOption
• type ReplicationOptionValue
• type StringReplicationOptionValue
  • func (ov StringReplicationOptionValue) GetValue() interface{}
  • func (ov StringReplicationOptionValue) GetValueAsString() string
  • func (ov StringReplicationOptionValue) String() string
• type TableNamesReplicationOptionValue
  • func (ov TableNamesReplicationOptionValue) GetValue() interface{}
  • func (ov TableNamesReplicationOptionValue) GetValueAsTableList() []sql.UnresolvedTable
  • func (ov TableNamesReplicationOptionValue) String() string

Constants

const (
	ReplicaIoNotRunning  = "No"
	ReplicaIoConnecting  = "Connecting"
	ReplicaIoRunning     = "Yes"
	ReplicaSqlNotRunning = "No"
	ReplicaSqlRunning    = "Yes"
)

Types

type BinlogPrimaryCatalog

type BinlogPrimaryCatalog interface {
	// HasBinlogPrimaryController returns true if a non-nil BinlogPrimaryController is available for this BinlogPrimaryCatalog.
	HasBinlogPrimaryController() bool
	// GetBinlogPrimaryController returns the BinlogPrimaryController registered with this BinlogPrimaryCatalog.
	GetBinlogPrimaryController() BinlogPrimaryController
}

BinlogPrimaryCatalog extends the Catalog interface and provides methods for accessing a BinlogPrimaryController for a Catalog.

type BinlogPrimaryController

type BinlogPrimaryController interface {
	// RegisterReplica tells the binlog primary controller to register a new replica on connection |c| with the
	// primary server. |replicaHost| and |replicaPort| specify where the replica can be accessed, and are returned
	// from the SHOW REPLICAS statement. Integrators should return from this method as soon as the replica is
	// registered.
	RegisterReplica(ctx *sql.Context, c *mysql.Conn, replicaHost string, replicaPort uint16) error

	// BinlogDumpGtid tells this binlog primary controller to start streaming binlog events to the replica over the
	// current connection, |c|. |gtidSet| specifies the point at which to start replication, or if it is nil, then
	// it indicates the complete history of all transactions should be sent over the connection. Note that unlike
	// other methods, this method does NOT return immediately (unless an error is encountered) – the connection is
	// left open for the duration of the replication stream, which could be days, or longer.
	BinlogDumpGtid(ctx *sql.Context, c *mysql.Conn, gtidSet mysql.GTIDSet) error

	// ListReplicas is called when the SHOW REPLICAS statement is executed. The integrator should return a list
	// of all registered replicas who are healthy and still responsive. Note that this function will be expanded
	// with an additional response parameter once it is wired up to the SQL engine.
	ListReplicas(ctx *sql.Context) error

	// ListBinaryLogs is called when the SHOW BINARY LOGS statement is executed. The integrator should return a list
	// of the binary logs currently being managed. Note that this function will be expanded
	// with an additional response parameter once it is wired up to the SQL engine.
	ListBinaryLogs(ctx *sql.Context) error

	// GetBinaryLogStatus is called when the SHOW BINARY LOG STATUS statement is executed. The integrator should return
	// the current status of the binary log. Note that this function will be expanded
	// with an additional response parameter once it is wired up to the SQL engine.
	GetBinaryLogStatus(ctx *sql.Context) error
}

BinlogPrimaryController allows an integrator to extend GMS with support for operating as a binlog primary server. Providers built on go-mysql-server may optionally implement this interface and use it when constructing a SQL engine in order to receive callbacks when replication statements for a primary server are received (e.g. SHOW BINARY LOG STATUS) or when MySQL protocol commands related to replication are received (e.g. COM_REGISTER_REPLICA).

type BinlogReplicaCatalog

type BinlogReplicaCatalog interface {
	// HasBinlogReplicaController returns true if a non-nil BinlogReplicaController is available for this BinlogReplicaCatalog.
	HasBinlogReplicaController() bool
	// GetBinlogReplicaController returns the BinlogReplicaController registered with this BinlogReplicaCatalog.
	GetBinlogReplicaController() BinlogReplicaController
}

BinlogReplicaCatalog extends the Catalog interface and provides methods for accessing a BinlogReplicaController for a Catalog.

type BinlogReplicaController

type BinlogReplicaController interface {
	// StartReplica tells the binlog replica controller to start up replication processes for the current replication
	// configuration. An error is returned if replication was unable to be started. Note the error response only signals
	// whether there was a problem with the initial replication start up. Replication could fail after being started up
	// successfully with no error response returned.
	StartReplica(ctx *sql.Context) error

	// StopReplica tells the binlog replica controller to stop all replication processes. An error is returned if there
	// were any problems stopping replication. If no replication processes were running, no error is returned.
	StopReplica(ctx *sql.Context) error

	// SetReplicationSourceOptions configures the binlog replica controller with the specified source options. The
	// replica controller must store this configuration. If any errors are encountered processing and storing the
	// configuration options, an error is returned.
	SetReplicationSourceOptions(ctx *sql.Context, options []ReplicationOption) error

	// SetReplicationFilterOptions configures the binlog replica controller with the specified filter options. Although
	// the official MySQL implementation does *NOT* persist these options, the replica controller should persist them.
	// (MySQL requires these options to be manually set after every server restart, or to be specified as command line
	// arguments when starting the MySQL process.) If any errors are encountered processing and storing the filter
	// options, an error is returned.
	SetReplicationFilterOptions(ctx *sql.Context, options []ReplicationOption) error

	// GetReplicaStatus returns the current status of the replica, or nil if no replication processes are running. If
	// any problems are encountered assembling the replica's status, an error is returned.
	GetReplicaStatus(ctx *sql.Context) (*ReplicaStatus, error)

	// ResetReplica resets the state for the replica. When the |resetAll| parameter is false, a "soft" or minimal reset
	// is performed – replication errors are reset, but connection information and filters are NOT reset. If |resetAll|
	// is true, a "hard" reset is performed – replication filters are removed, replication source options are removed,
	// and `SHOW REPLICA STATUS` shows no results. If replication is currently running, this function should return an
	// error indicating that replication needs to be stopped before it can be reset. If any errors were encountered
	// resetting the replica state, an error is returned, otherwise nil is returned if the reset was successful.
	ResetReplica(ctx *sql.Context, resetAll bool) error
}

BinlogReplicaController allows callers to control a binlog replica. Providers built on go-mysql-server may optionally implement this interface and use it when constructing a SQL engine in order to receive callbacks when replication statements (e.g. START REPLICA, SHOW REPLICA STATUS) are being handled.

type IntegerReplicationOptionValue

type IntegerReplicationOptionValue struct {
	Value int
}

IntegerReplicationOptionValue is a ReplicationOptionValue implementation that holds an integer value.

func (IntegerReplicationOptionValue) GetValue

func (ov IntegerReplicationOptionValue) GetValue() interface{}

func (IntegerReplicationOptionValue) GetValueAsInt

func (ov IntegerReplicationOptionValue) GetValueAsInt() int

func (IntegerReplicationOptionValue) String

func (ov IntegerReplicationOptionValue) String() string

String implements the Stringer interface and returns a string representation of this option value.

type ReplicaStatus

type ReplicaStatus struct {
	SourceHost            string
	SourceUser            string
	SourcePort            uint
	ConnectRetry          uint32
	SourceRetryCount      uint64
	ReplicaIoRunning      string
	ReplicaSqlRunning     string
	LastSqlErrNumber      uint   // Alias for LastErrNumber
	LastSqlError          string // Alias for LastError
	LastIoErrNumber       uint
	LastIoError           string
	SourceServerId        string
	SourceServerUuid      string
	LastSqlErrorTimestamp *time.Time
	LastIoErrorTimestamp  *time.Time
	RetrievedGtidSet      string
	ExecutedGtidSet       string
	AutoPosition          bool
	ReplicateDoTables     []string
	ReplicateIgnoreTables []string
}

ReplicaStatus stores the status of a single binlog replica and is returned by `SHOW REPLICA STATUS`. https://dev.mysql.com/doc/refman/8.0/en/show-replica-status.html

type ReplicationOption

type ReplicationOption struct {
	Name  string
	Value ReplicationOptionValue
}

ReplicationOption represents a single option for replication configuration, as specified through the CHANGE REPLICATION SOURCE TO command: https://dev.mysql.com/doc/refman/8.0/en/change-replication-source-to.html

func NewReplicationOption

func NewReplicationOption(name string, value ReplicationOptionValue) *ReplicationOption

NewReplicationOption creates a new ReplicationOption instance, with the specified |name| and |value|.

type ReplicationOptionValue

type ReplicationOptionValue interface {
	fmt.Stringer

	// GetValue returns the raw, untyped option value. This method should generally not be used; callers should instead
	// find the specific type implementing the ReplicationOptionValue interface and use its functions in order to get
	// typed values.
	GetValue() interface{}
}

ReplicationOptionValue defines an interface for configuration option values for binlog replication. It holds the values of options for configuring the replication source (i.e. "CHANGE REPLICATION SOURCE TO" options) and for replication filtering (i.g. "SET REPLICATION FILTER" options).

type StringReplicationOptionValue

type StringReplicationOptionValue struct {
	Value string
}

StringReplicationOptionValue is a ReplicationOptionValue implementation that holds a string value.

func (StringReplicationOptionValue) GetValue

func (ov StringReplicationOptionValue) GetValue() interface{}

func (StringReplicationOptionValue) GetValueAsString

func (ov StringReplicationOptionValue) GetValueAsString() string

func (StringReplicationOptionValue) String

func (ov StringReplicationOptionValue) String() string

String implements the Stringer interface and returns a string representation of this option value.

type TableNamesReplicationOptionValue

type TableNamesReplicationOptionValue struct {
	Value []sql.UnresolvedTable
}

TableNamesReplicationOptionValue is a ReplicationOptionValue implementation that holds a list of table names for its value.

func (TableNamesReplicationOptionValue) GetValue

func (ov TableNamesReplicationOptionValue) GetValue() interface{}

func (TableNamesReplicationOptionValue) GetValueAsTableList

func (ov TableNamesReplicationOptionValue) GetValueAsTableList() []sql.UnresolvedTable

func (TableNamesReplicationOptionValue) String

func (ov TableNamesReplicationOptionValue) String() string

String implements the Stringer interface and returns a string representation of this option value.