http

Documentation

Index

• Constants
• Variables
• func CompileMatch(s string) (*regexp.Regexp, error)
• func Error(w http.ResponseWriter, r *http.Request, err error, code int)
• func ReadPosMapFrom(r io.Reader) (map[string]ltx.Pos, error)
• func WritePosMapTo(w io.Writer, m map[string]ltx.Pos) error
• type Client
  • func NewClient() *Client
  • func (c *Client) AcquireHaltLock(ctx context.Context, primaryURL string, nodeID uint64, name string, ...) (_ *litefs.HaltLock, retErr error)
  • func (c *Client) Commit(ctx context.Context, primaryURL string, nodeID uint64, name string, ...) error
  • func (c *Client) Export(ctx context.Context, primaryURL, name string) (io.ReadCloser, error)
  • func (c *Client) Handoff(ctx context.Context, primaryURL string, nodeID uint64) error
  • func (c *Client) Import(ctx context.Context, primaryURL, name string, r io.Reader) error
  • func (c *Client) Info(ctx context.Context, baseURL string) (info litefs.NodeInfo, err error)
  • func (c *Client) Promote(ctx context.Context, baseURL string) error
  • func (c *Client) ReleaseHaltLock(ctx context.Context, primaryURL string, nodeID uint64, name string, ...) error
  • func (c *Client) Stream(ctx context.Context, primaryURL string, nodeID uint64, ...) (litefs.Stream, error)
• type ProxyServer
  • func NewProxyServer(store *litefs.Store) *ProxyServer
  • func (s *ProxyServer) Close() (err error)
  • func (s *ProxyServer) Listen() (err error)
  • func (s *ProxyServer) Port() int
  • func (s *ProxyServer) Serve()
  • func (s *ProxyServer) URL() string
• type RemoteTx
  • func (tx *RemoteTx) Commit(r io.Reader) error
  • func (tx *RemoteTx) ID() uint64
  • func (tx *RemoteTx) PreApplyChecksum() uint64
  • func (tx *RemoteTx) Rollback() error
• type Server
  • func NewServer(store *litefs.Store, addr string) *Server
  • func (s *Server) Close() (err error)
  • func (s *Server) Listen() (err error)
  • func (s *Server) Port() int
  • func (s *Server) Serve()
  • func (s *Server) URL() string
• type Stream
  • func (s *Stream) ClusterID() string

Constants

const (
	DefaultPollTXIDInterval = 1 * time.Millisecond
	DefaultPollTXIDTimeout  = 5 * time.Second

	DefaultPrimaryRedirectTimeout = 5 * time.Second

	DefaultMaxLag = 10 * time.Second

	DefaultCookieExpiry = 5 * time.Minute

	DefaultReadTimeout       = 0
	DefaultReadHeaderTimeout = 10 * time.Second
	DefaultWriteTimeout      = 0
	DefaultIdleTimeout       = 30 * time.Second
)

const (
	HeaderNodeID    = "Litefs-Id"
	HeaderClusterID = "Litefs-Cluster-Id"
)

HTTP headers

const (
	DefaultAddr = ":20202"
)

Default settings

const (
	HeartbeatInterval = time.Second
)

const TXIDCookieName = "__txid"

TXIDCookieName is the name of the cookie that tracks transaction ID.

Variables

var ErrProxyServerClosed = fmt.Errorf("canceled, proxy server closed")

var ErrServerClosed = fmt.Errorf("canceled, http server closed")

Functions

func CompileMatch

func CompileMatch(s string) (*regexp.Regexp, error)

CompileMatch returns a regular expression on a simple asterisk-only wildcard.

func Error

func Error(w http.ResponseWriter, r *http.Request, err error, code int)

func ReadPosMapFrom

func ReadPosMapFrom(r io.Reader) (map[string]ltx.Pos, error)

func WritePosMapTo

func WritePosMapTo(w io.Writer, m map[string]ltx.Pos) error

Types

type Client

type Client struct {
	// Underlying HTTP client
	HTTPClient *http.Client
}

Client represents an client for a streaming LiteFS HTTP server.

func NewClient

func NewClient() *Client

NewClient returns an instance of Client.

func (*Client) AcquireHaltLock

func (c *Client) AcquireHaltLock(ctx context.Context, primaryURL string, nodeID uint64, name string, lockID int64) (_ *litefs.HaltLock, retErr error)

func (*Client) Commit

func (c *Client) Commit(ctx context.Context, primaryURL string, nodeID uint64, name string, lockID int64, r io.Reader) error

func (*Client) Export

func (c *Client) Export(ctx context.Context, primaryURL, name string) (io.ReadCloser, error)

Export downloads a SQLite database from the remote LiteFS server. Returned reader must be closed by caller.

func (*Client) Handoff

func (c *Client) Handoff(ctx context.Context, primaryURL string, nodeID uint64) error

Handoff requests that the current primary handoff leadership to a specific node.

func (*Client) Import

func (c *Client) Import(ctx context.Context, primaryURL, name string, r io.Reader) error

Import creates or replaces a SQLite database on the remote LiteFS server.

func (*Client) Info

func (c *Client) Info(ctx context.Context, baseURL string) (info litefs.NodeInfo, err error)

Info returns basic information about the node.

func (*Client) Promote

func (c *Client) Promote(ctx context.Context, baseURL string) error

Promote attempts to promote the current node to be the primary.

func (*Client) ReleaseHaltLock

func (c *Client) ReleaseHaltLock(ctx context.Context, primaryURL string, nodeID uint64, name string, lockID int64) error

func (*Client) Stream

func (c *Client) Stream(ctx context.Context, primaryURL string, nodeID uint64, posMap map[string]ltx.Pos, filter []string) (litefs.Stream, error)

Stream returns a snapshot and continuous stream of WAL updates.

type ProxyServer

type ProxyServer struct {

	// Hostport of application that is being proxied.
	Target string

	// Name of database to use for TXID consistency tracking.
	DBName string

	// Bind address that the proxy listens on.
	Addr string

	// List of path expressions that will be passed through if matched.
	Passthroughs []*regexp.Regexp

	// List of path expressions that will always be redirected to the primary.
	AlwaysForward []*regexp.Regexp

	// If true, add verbose debug logging.
	Debug bool

	// Interval & timeout for ensuring read consistency.
	PollTXIDInterval time.Duration
	PollTXIDTimeout  time.Duration

	PrimaryRedirectTimeout time.Duration

	// Maximum allowable lag before the health endpoint returns an error code.
	MaxLag time.Duration

	// Time before cookie expires on client.
	CookieExpiry time.Duration

	// HTTP server timeouts
	ReadTimeout       time.Duration
	ReadHeaderTimeout time.Duration
	WriteTimeout      time.Duration
	IdleTimeout       time.Duration

	HTTPTransport *http.Transport
	// contains filtered or unexported fields
}

ProxyServer represents a thin proxy in front of the user's application that can handle primary redirection and TXID consistency on replicas.

Exported fields must be set before calling Listen().

func NewProxyServer

func NewProxyServer(store *litefs.Store) *ProxyServer

NewProxyServer returns a new instance of ProxyServer.

func (*ProxyServer) Close

func (s *ProxyServer) Close() (err error)

func (*ProxyServer) Listen

func (s *ProxyServer) Listen() (err error)

func (*ProxyServer) Port

func (s *ProxyServer) Port() int

Port returns the port the listener is running on.

func (*ProxyServer) Serve

func (s *ProxyServer) Serve()

func (*ProxyServer) URL

func (s *ProxyServer) URL() string

URL returns the full base URL for the running server.

type RemoteTx

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

RemoteTx represents a remote transaction created by Client.Begin().

func (*RemoteTx) Commit

func (tx *RemoteTx) Commit(r io.Reader) error

Commit send the LTX data from r to the remote primary for commit.

func (*RemoteTx) ID

func (tx *RemoteTx) ID() uint64

ID returns the TXID of the transaction.

func (*RemoteTx) PreApplyChecksum

func (tx *RemoteTx) PreApplyChecksum() uint64

PreApplyChecksum returns checksum of the database before the transaction is applied.

func (*RemoteTx) Rollback

func (tx *RemoteTx) Rollback() error

Rollback closes the connection without sending a transaction, thus rolling back.

type Server

type Server struct {

	// Time allowed to write a single LTX snapshot in the stream.
	// This is meant to prevent slow snapshot downloads backing up the primary.
	SnapshotTimeout time.Duration
	// contains filtered or unexported fields
}

Server represents an HTTP API server for LiteFS.

func NewServer

func NewServer(store *litefs.Store, addr string) *Server

func (*Server) Close

func (s *Server) Close() (err error)

func (*Server) Listen

func (s *Server) Listen() (err error)

func (*Server) Port

func (s *Server) Port() int

Port returns the port the listener is running on.

func (*Server) Serve

func (s *Server) Serve()

func (*Server) URL

func (s *Server) URL() string

URL returns the full base URL for the running server.

type Stream

type Stream struct {
	io.ReadCloser
	// contains filtered or unexported fields
}

Stream is a wrapper around the stream response body.

func (*Stream) ClusterID

func (s *Stream) ClusterID() string

ClusterID returns the cluster ID found in the response header.