server

May 13, 2025

Changes in this version

type Config

+ MaxWaitConnections uint32

+ MaxWaitConnectionsTimeout time.Duration

+ ProtocolListenerFactory ProtocolListenerFunc

+ type InterceptorChain struct

+ func (ic *InterceptorChain) Option() Option

+ func (ic *InterceptorChain) WithInterceptor(h Interceptor)

type ProtocolListener

+ func MySQLProtocolListenerFactory(cfg Config, listenerCfg mysql.ListenerConfig, sel ServerEventListener) (ProtocolListener, error)

type SessionManager

+ func (s *SessionManager) WaitForClosedConnections()

Dec 19, 2024

Changes in this version

+ func GetDeferredProjections(iter sql.RowIter) (sql.RowIter, []sql.Expression)

+ func RowToSQL(ctx *sql.Context, sch sql.Schema, row sql.Row, projs []sql.Expression) ([]sqltypes.Value, error)

type Handler

+ func (h *Handler) ConnectionAborted(_ *mysql.Conn, _ string) error

+ func (h *Handler) NewContext(ctx context.Context, c *mysql.Conn, query string) (*sql.Context, error)

type SessionManager

+ func (s *SessionManager) GetCurrentDB(conn *mysql.Conn) string

Apr 9, 2024

Changes in this version

type Handler

+ func (h *Handler) ComBinlogDumpGTID(c *mysql.Conn, logFile string, logPos uint64, gtidSet mysql.GTIDSet) error

+ func (h *Handler) ComRegisterReplica(c *mysql.Conn, replicaHost string, replicaPort uint16, replicaUser string, ...) error

+ type HandlerWrapper func(h mysql.Handler) (mysql.Handler, error)

type Server

+ func NewServerWithHandler(cfg Config, e *sqle.Engine, sb SessionBuilder, listener ServerEventListener, ...) (*Server, error)

Feb 28, 2024

Changes in this version

+ func Intercept(h Interceptor)

+ type Chain interface

+ ComMultiQuery func(c *mysql.Conn, query string, callback mysql.ResultSpoolFn) (string, error)

+ ComPrepare func(c *mysql.Conn, query string, prepare *mysql.PrepareData) ([]*querypb.Field, error)

+ ComQuery func(c *mysql.Conn, query string, callback mysql.ResultSpoolFn) error

+ ComStmtExecute func(c *mysql.Conn, prepare *mysql.PrepareData, ...) error

type Config

+ Listener net.Listener

+ Options []Option

type Handler

+ func (h *Handler) ComBind(c *mysql.Conn, query string, parsedQuery mysql.ParsedQuery, ...) (mysql.BoundQuery, []*querypb.Field, error)

+ func (h *Handler) ComExecuteBound(c *mysql.Conn, query string, boundQuery mysql.BoundQuery, ...) error

+ func (h *Handler) ComParsedQuery(c *mysql.Conn, query string, parsed sqlparser.Statement, ...) error

+ func (h *Handler) ComPrepareParsed(c *mysql.Conn, query string, parsed sqlparser.Statement, ...) (mysql.ParsedQuery, []*querypb.Field, error)

+ type Interceptor interface

+ MultiQuery func(chain Chain, c *mysql.Conn, query string, ...) (string, error)

+ ParsedQuery func(chain Chain, c *mysql.Conn, query string, parsed sqlparser.Statement, ...) error

+ Prepare func(chain Chain, c *mysql.Conn, query string, prepare *mysql.PrepareData) ([]*querypb.Field, error)

+ Priority func() int

+ Query func(chain Chain, c *mysql.Conn, query string, ...) error

+ StmtExecute func(chain Chain, c *mysql.Conn, prepare *mysql.PrepareData, ...) error

+ type Option func(e *sqle.Engine, sm *SessionManager, handler mysql.Handler)

+ func WithChain() Option

+ type ProtocolListener interface

+ Accept func()

+ Addr func() net.Addr

+ Close func()

+ type ProtocolListenerFunc func(cfg mysql.ListenerConfig) (ProtocolListener, error)

+ var DefaultProtocolListenerFunc ProtocolListenerFunc = func(cfg mysql.ListenerConfig) (ProtocolListener, error) { ... }

+ type QueryExecutor func(ctx *sql.Context, query string, parsed sqlparser.Statement, analyzed sql.Node, ...) (sql.Schema, sql.RowIter, error)

type Server

+ func (s *Server) WarnIfLoadFileInsecure()

Aug 23, 2023

Changes in this version

type Handler

+ func (h *Handler) ParserOptionsForConnection(c *mysql.Conn) (sqlparser.ParserOptions, error)

Apr 18, 2023

Changes in this version

+ var UnixSocketInUseError = errors.New("bind address at given unix socket path is already in use")

type Config

+ EncodeLoggedQuery bool

+ MaxLoggedQueryLen int

type Server

+ Engine *gms.Engine

type SessionManager

+ func (s *SessionManager) AddConn(conn *mysql.Conn)

+ func (s *SessionManager) RemoveConn(conn *mysql.Conn)

Nov 1, 2022

Changes in this version

type Config

+ AllowClearTextWithoutTLS bool

+ Socket string

type Listener

+ func (l *Listener) Addr() net.Addr

+ func (l *Listener) Close() error

type Server

+ func NewValidatingServer(cfg Config, e *sqle.Engine, sb SessionBuilder, listener ServerEventListener, ...) (*Server, error)

type SessionManager

+ func (s *SessionManager) KillConnection(connID uint32) error

Jun 12, 2022

Changes in this version

type Config

+ DisableClientMultiStatements bool

+ NoDefaults bool

+ func (c Config) NewConfig() (Config, error)

type Handler

+ func (h *Handler) ComMultiQuery(c *mysql.Conn, query string, callback func(*sqltypes.Result, bool) error) (string, error)

+ type MultiStmtMode int

+ const MultiStmtModeOff

+ const MultiStmtModeOn

type Server

+ func (s *Server) SessionManager() *SessionManager

+ type ServerEventListener interface

+ ClientConnected func()

+ ClientDisconnected func()

+ QueryCompleted func(success bool, duration time.Duration)

+ QueryStarted func()

type SessionManager

+ func (s *SessionManager) Iter(f func(session sql.Session) (stop bool, err error)) error

Oct 20, 2021

Changes in this version

type Config

+ RequireSecureTransport bool

+ TLSConfig *tls.Config

Jun 2, 2021

Changes in this version

+ var QueryCounter = discard.NewCounter()

+ var QueryErrorCounter = discard.NewCounter()

+ var QueryHistogram = discard.NewHistogram()

Feb 1, 2021

Changes in this version

+ var ErrConnectionWasClosed = errors.NewKind("connection was closed")

+ var ErrRowTimeout = errors.NewKind("row read wait bigger than connection timeout")

+ var ErrUnsupportedOperation = errors.NewKind("unsupported operation")

+ func DefaultSessionBuilder(ctx context.Context, c *mysql.Conn, addr string) (sql.Session, *sql.IndexRegistry, *sql.ViewRegistry, error)

+ type Config struct

+ Address string

+ Auth auth.Auth

+ ConnReadTimeout time.Duration

+ ConnWriteTimeout time.Duration

+ MaxConnections uint64

+ Protocol string

+ Tracer opentracing.Tracer

+ Version string

+ type DoneFunc func()

+ type Handler struct

+ func NewHandler(e *sqle.Engine, sm *SessionManager, rt time.Duration) *Handler

+ func (h *Handler) AddNetConnection(c *net.Conn)

+ func (h *Handler) ComInitDB(c *mysql.Conn, schemaName string) error

+ func (h *Handler) ComPrepare(c *mysql.Conn, query string) ([]*query.Field, error)

+ func (h *Handler) ComQuery(c *mysql.Conn, query string, callback func(*sqltypes.Result) error) error

+ func (h *Handler) ComResetConnection(c *mysql.Conn)

+ func (h *Handler) ComStmtExecute(c *mysql.Conn, prepare *mysql.PrepareData, ...) error

+ func (h *Handler) ConnectionClosed(c *mysql.Conn)

+ func (h *Handler) NewConnection(c *mysql.Conn)

+ func (h *Handler) WarningCount(c *mysql.Conn) uint16

+ type Listener struct

+ func NewListener(protocol, address string, handler *Handler) (*Listener, error)

+ func (l *Listener) Accept() (net.Conn, error)

+ type Server struct

+ Listener *mysql.Listener

+ func NewDefaultServer(cfg Config, e *sqle.Engine) (*Server, error)

+ func NewServer(cfg Config, e *sqle.Engine, sb SessionBuilder) (*Server, error)

+ func (s *Server) Close() error

+ func (s *Server) Start() error

+ type SessionBuilder func(ctx context.Context, conn *mysql.Conn, addr string) (sql.Session, *sql.IndexRegistry, *sql.ViewRegistry, error)

+ type SessionManager struct

+ func NewSessionManager(builder SessionBuilder, tracer opentracing.Tracer, ...) *SessionManager

+ func (s *SessionManager) CloseConn(conn *mysql.Conn)

+ func (s *SessionManager) NewContext(conn *mysql.Conn) (*sql.Context, error)

+ func (s *SessionManager) NewContextWithQuery(conn *mysql.Conn, query string) (*sql.Context, error)

+ func (s *SessionManager) NewSession(ctx context.Context, conn *mysql.Conn) error

+ func (s *SessionManager) SetDB(conn *mysql.Conn, db string) error