server

Documentation

Index

• Constants
• func NewLimitedListener(listenerCfg mysql.ListenerConfig) (server.ProtocolListener, error)
• func NewListener(listenerCfg mysql.ListenerConfig) (server.ProtocolListener, error)
• func RunInMemory(args []string) (*svcs.Controller, error)
• func RunOnDisk(ctx context.Context, args []string, dEnv *env.DoltEnv) (*svcs.Controller, error)
• type ConnectionHandler
  • func NewConnectionHandler(conn net.Conn, handler mysql.Handler) *ConnectionHandler
  • func (h *ConnectionHandler) Conn() net.Conn
  • func (h *ConnectionHandler) HandleConnection()
• type ConvertedQuery
• type LimitedListener
  • func (l *LimitedListener) Accept()
  • func (l *LimitedListener) Addr() net.Addr
  • func (l *LimitedListener) Close()
• type Listener
  • func (l *Listener) Accept()
  • func (l *Listener) Addr() net.Addr
  • func (l *Listener) Close()
• type PortalData
• type PreparedStatementData

Constants

const (
	Version = "0.4.0"

	// DOLTGRES_DATA_DIR is an environment variable that defines the location of DoltgreSQL databases
	DOLTGRES_DATA_DIR = "DOLTGRES_DATA_DIR"
	// DOLTGRES_DATA_DIR_DEFAULT is the portion to append to the user's home directory if DOLTGRES_DATA_DIR has not been specified
	DOLTGRES_DATA_DIR_DEFAULT = "doltgres/databases"

	DefUserName  = "postres"
	DefUserEmail = "postgres@somewhere.com"
	DoltgresDir  = "doltgres"
)

Functions

func NewLimitedListener

func NewLimitedListener(listenerCfg mysql.ListenerConfig) (server.ProtocolListener, error)

NewLimitedListener creates a new LimitedListener.

func NewListener

func NewListener(listenerCfg mysql.ListenerConfig) (server.ProtocolListener, error)

NewListener creates a new Listener.

func RunInMemory

func RunInMemory(args []string) (*svcs.Controller, error)

RunInMemory starts the server based on the given args, while also using RAM as the backing store. The returned WaitGroup may be used to wait for the server to close.

func RunOnDisk

func RunOnDisk(ctx context.Context, args []string, dEnv *env.DoltEnv) (*svcs.Controller, error)

RunOnDisk starts the server based on the given args, while also using the local disk as the backing store. The returned WaitGroup may be used to wait for the server to close.

Types

type ConnectionHandler

type ConnectionHandler struct {
	// contains filtered or unexported fields
}

ConnectionHandler is responsible for the entire lifecycle of a user connection: receiving messages they send, executing queries, sending the correct messages in return, and terminating the connection when appropriate.

func NewConnectionHandler

func NewConnectionHandler(conn net.Conn, handler mysql.Handler) *ConnectionHandler

NewConnectionHandler returns a new ConnectionHandler for the connection provided

func (*ConnectionHandler) Conn

func (h *ConnectionHandler) Conn() net.Conn

Conn returns the underlying net.Conn for this connection.

func (*ConnectionHandler) HandleConnection

func (h *ConnectionHandler) HandleConnection()

HandleConnection handles a connection's session, reading messages, executing queries, and sending responses. Expected to run in a goroutine per connection.

type ConvertedQuery

type ConvertedQuery struct {
	String string
	AST    vitess.Statement
}

ConvertedQuery represents a query that has been converted from the Postgres representation to the Vitess representation. String may contain the string version of the converted query. AST will contain the tree version of the converted query, and is the recommended form to use. If AST is nil, then use the String version, otherwise always prefer to AST.

type LimitedListener

type LimitedListener struct {
	// contains filtered or unexported fields
}

LimitedListener automatically shuts down the listener after two connections close. This is intended only for testing. Tests will always make use of two connections, and they are as follows: 1. Establish a connection, and create the database. Disconnect afterward (Postgres enforces one connection per database). 2. Establish a connection, and run all of the queries relevant to the database. Tests that do not use the framework provided may not adhere to the above rules, and therefore must find another way to properly close their servers.

func (*LimitedListener) Accept

func (l *LimitedListener) Accept()

Accept implements the interface server.ProtocolListener.

func (*LimitedListener) Addr

func (l *LimitedListener) Addr() net.Addr

Addr implements the interface server.ProtocolListener.

func (*LimitedListener) Close

func (l *LimitedListener) Close()

Close implements the interface server.ProtocolListener.

type Listener

type Listener struct {
	// contains filtered or unexported fields
}

Listener listens for connections to process PostgreSQL requests into Dolt requests.

func (*Listener) Accept

func (l *Listener) Accept()

Accept handles incoming connections.

func (*Listener) Addr

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

Addr returns the address that the listener is listening on.

func (*Listener) Close

func (l *Listener) Close()

Close stops the handling of incoming connections.

type PortalData

type PortalData struct {
	Query        ConvertedQuery
	IsEmptyQuery bool
	Fields       []*querypb.Field
	BoundPlan    sql.Node
}

type PreparedStatementData

type PreparedStatementData struct {
	Query        ConvertedQuery
	ReturnFields []*querypb.Field
	BindVarTypes []int32
}