Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
Functions ¶
Types ¶
type DB ¶
type DB interface { Begin(ctx context.Context) (pgx.Tx, error) Exec(ctx context.Context, query string, args ...interface{}) (pgconn.CommandTag, error) Query(ctx context.Context, query string, args ...interface{}) (pgx.Rows, error) QueryRow(ctx context.Context, query string, args ...interface{}) pgx.Row }
DB is the interface for a pgx database connection.
type RiverJob ¶
type RiverJob struct { ID int64 `json:"id"` Args json.RawMessage `json:"args"` Attempt int `json:"attempt"` AttemptedAt *time.Time `json:"attempted_at"` AttemptedBy []string `json:"attempted_by"` CreatedAt time.Time `json:"created_at"` Errors []rivertype.AttemptError `json:"errors"` FinalizedAt *time.Time `json:"finalized_at"` Kind string `json:"kind"` MaxAttempts int `json:"max_attempts"` Metadata json.RawMessage `json:"metadata"` Priority int `json:"priority"` Queue string `json:"queue"` ScheduledAt time.Time `json:"scheduled_at"` State string `json:"state"` Tags []string `json:"tags"` }
type RiverQueue ¶
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server is an HTTP server that serves the River UI and API. It must be started with Start to initialize caching and background query functionality prior to serving requests. Server implements http.Handler, so it can be directly mounted in an http.ServeMux.
func NewServer ¶
func NewServer(opts *ServerOpts) (*Server, error)
NewServer creates a new Server that serves the River UI and API.
func (*Server) ServeHTTP ¶
func (s *Server) ServeHTTP(rw http.ResponseWriter, req *http.Request)
ServeHTTP returns an http.ServeHTTP that can be mounted to serve HTTP requests.
func (*Server) Start ¶
Start starts the server's background services. Notably, this does _not_ cause the server to start listening for HTTP in any way. To serve HTTP requests, the Server implements `http.Handler` via a `ServeHTTP` method and can be mounted in an existing `http.ServeMux`.
type ServerOpts ¶
type ServerOpts struct { // Client is the River client to use for API requests. Client *river.Client[pgx.Tx] // DB is the database to use for API requests. DB DB // DevMode is whether the server is running in development mode. DevMode bool // LiveFS is whether to use the live filesystem for the frontend. LiveFS bool // Logger is the logger to use logging errors within the handler. Logger *slog.Logger // Prefix is the path prefix to use for the API and UI HTTP requests. Prefix string }
ServerOpts are the options for creating a new Server.
Source Files
¶
Directories
¶
Path | Synopsis |
---|---|
cmd
|
|
internal
|
|
apiendpoint
Package apiendpoint provides a lightweight API framework for use with River UI.
|
Package apiendpoint provides a lightweight API framework for use with River UI. |
apierror
Package apierror contains a variety of marshalable API errors that adhere to a unified error response convention.
|
Package apierror contains a variety of marshalable API errors that adhere to a unified error response convention. |
validate
Package validate internalizes Go Playground's Validator framework, setting some common options that we use everywhere, providing some useful helpers, and exporting a simplified API.
|
Package validate internalizes Go Playground's Validator framework, setting some common options that we use everywhere, providing some useful helpers, and exporting a simplified API. |