mysql

Documentation

Overview

Package mysql provides the functions for handling vald's data with MySQL.

Index

• type EventReceiver
• type Getter
• type MySQL
  • func New(opts ...Option) (MySQL, error)
• type NullEventReceiver
• type Option
  • func WithCharset(cs string) Option
  • func WithConnectionLifeTimeLimit(dur string) Option
  • func WithDB(db string) Option
  • func WithDialer(der net.Dialer) Option
  • func WithDialerFunc(der func(ctx context.Context, addr, port string) (net.Conn, error)) Option
  • func WithEventReceiver(er EventReceiver) Option
  • func WithHost(host string) Option
  • func WithInitialPingDuration(dur string) Option
  • func WithInitialPingTimeLimit(lim string) Option
  • func WithMaxIdleConns(conns int) Option
  • func WithMaxOpenConns(conns int) Option
  • func WithName(name string) Option
  • func WithNetwork(network string) Option
  • func WithPass(pass string) Option
  • func WithPort(port uint16) Option
  • func WithSocketPath(socketPath string) Option
  • func WithTLSConfig(cfg *tls.Config) Option
  • func WithTimezone(tz string) Option
  • func WithUser(user string) Option
• type Setter
• type TracingEventReceiver
• type Vector

Types

type EventReceiver

type EventReceiver = dbr.EventReceiver

type Getter

type Getter interface {
	GetVector(ctx context.Context, uuid string) (Vector, error)
	GetIPs(ctx context.Context, uuid string) ([]string, error)
}

type MySQL

type MySQL interface {
	Open(ctx context.Context) error
	Close(ctx context.Context) error
	Getter
	Setter
}

MySQL represents the interface to handle MySQL operation.

func New

func New(opts ...Option) (MySQL, error)

New creates the new mySQLClient with option. It will return error when set option is failed.

type NullEventReceiver

type NullEventReceiver = dbr.NullEventReceiver

type Option

type Option func(*mySQLClient) error

Option represents the functional option for mySQLClient.

func WithCharset

func WithCharset(cs string) Option

WithCharset returns the option to set the charset.

func WithConnectionLifeTimeLimit

func WithConnectionLifeTimeLimit(dur string) Option

WithConnectionLifeTimeLimit returns the option to set the connMaxLifeTime.

func WithDB

func WithDB(db string) Option

WithDB returns the option to set the db.

func WithDialer

func WithDialer(der net.Dialer) Option

WithDialer returns the option to set the dialer.

func WithDialerFunc

func WithDialerFunc(der func(ctx context.Context, addr, port string) (net.Conn, error)) Option

WithDialerFunc returns the option to set the dialer function.

func WithEventReceiver

func WithEventReceiver(er EventReceiver) Option

WithEventReceiver returns the option to set the eventReceiver.

func WithHost

func WithHost(host string) Option

WithHost returns the option to set the host.

func WithInitialPingDuration

func WithInitialPingDuration(dur string) Option

WithInitialPingDuration returns the option to set the initialPingDuration.

func WithInitialPingTimeLimit

func WithInitialPingTimeLimit(lim string) Option

WithInitialPingTimeLimit returns the option to set the initialPingTimeLimit.

func WithMaxIdleConns

func WithMaxIdleConns(conns int) Option

WithMaxIdleConns returns the option to set the maxIdleConns. If conns is negative numner, no idle connections are retained. ref: https://golang.org/src/database/sql/sql.go?s=24983:25019#L879

func WithMaxOpenConns

func WithMaxOpenConns(conns int) Option

WithMaxOpenConns returns the option to set the maxOpenConns. If conns is negative numner, no limit on the number of open connections. ref: https://golang.org/src/database/sql/sql.go?s=24983:25019#L923

func WithName

func WithName(name string) Option

WithName returns the option to sst the name.

func WithNetwork

func WithNetwork(network string) Option

WithNetwork returns the option to set the network type (tcp, unix).

func WithPass

func WithPass(pass string) Option

WithPass returns the option to set the pass.

func WithPort

func WithPort(port uint16) Option

WithPort returns the option to set the port.

func WithSocketPath

func WithSocketPath(socketPath string) Option

WithSocketPath returns the option to set the socketPath for unix domain socket connection.

func WithTLSConfig

func WithTLSConfig(cfg *tls.Config) Option

WithTLSConfig returns the option to set the tlsConfig.

func WithTimezone

func WithTimezone(tz string) Option

WithTimezone returns the option to set the timezone.

func WithUser

func WithUser(user string) Option

WithUser returns the option to set the user.

type Setter

type Setter interface {
	SetVector(ctx context.Context, vec Vector) error
	SetVectors(ctx context.Context, vecs ...Vector) error
	DeleteVector(ctx context.Context, uuid string) error
	DeleteVectors(ctx context.Context, uuids ...string) error
	SetIPs(ctx context.Context, uuid string, ips ...string) error
	RemoveIPs(ctx context.Context, ips ...string) error
}

type TracingEventReceiver

type TracingEventReceiver = dbr.TracingEventReceiver

type Vector

type Vector interface {
	GetUUID() string
	GetVector() []byte
	GetIPs() []string
}

Vector is an interface to handle vector keep in MySQL.