Documentation
¶
Overview ¶
Package riveruidriver defines the database operations that River UI adds on top of River's core driver. Database-specific implementations keep SQL dialect details out of HTTP endpoints while continuing to use the executor already owned by the caller's River client.
Index ¶
- Constants
- func NormalizeJobDeadLetterListResults(jobs []*JobDeadLetterListResult)
- type Driver
- type Executor
- type JobCountByAllStatesCappedParams
- type JobCountEstimateParams
- type JobCountEstimateResult
- type JobDeadLetterAutocompleteParams
- type JobDeadLetterFacet
- type JobDeadLetterFilters
- type JobDeadLetterListParams
- type JobDeadLetterListResult
Constants ¶
const ( // JobDeadLetterListMaxDefault is the number of jobs to list when the caller // has no preference. JobDeadLetterListMaxDefault = 20 // JobDeadLetterListMaxLimit is the largest Max that JobDeadLetterList // accepts. JobDeadLetterListMaxLimit = 200 // JobDeadLetterAutocompleteMaxLimit is the largest Max that // JobDeadLetterAutocomplete accepts. JobDeadLetterAutocompleteMaxLimit = 100 )
Variables ¶
This section is empty.
Functions ¶
func NormalizeJobDeadLetterListResults ¶ added in v0.22.0
func NormalizeJobDeadLetterListResults(jobs []*JobDeadLetterListResult)
NormalizeJobDeadLetterListResults puts decoded jobs into the form that every driver returns. Jobs are ordered by ID descending, because not every database guarantees the order of elements within an aggregated JSON array. Timestamps are in UTC, because PostgreSQL renders them in the session's time zone while SQLite renders them in UTC.
Types ¶
type Driver ¶
type Driver interface {
GetExecutor(riverExecutor riverdriver.Executor) Executor
}
Driver decorates a River executor with queries used only by River UI.
type Executor ¶
type Executor interface {
riverdriver.Executor
// JobCountByAllStatesCapped returns an exact count through Max and Max+1 as
// a sentinel when additional rows exist.
JobCountByAllStatesCapped(ctx context.Context, params *JobCountByAllStatesCappedParams) (map[rivertype.JobState]int, error)
// JobCountEstimate returns inexpensive database estimates where supported.
// Drivers without an estimate strategy return an empty map.
JobCountEstimate(ctx context.Context, params *JobCountEstimateParams) (map[rivertype.JobState]JobCountEstimateResult, error)
// JobDeadLetterList returns at most Max jobs, ordered by ID descending so
// the newest dead letter jobs come first and stay reachable when more jobs
// match than Max. Only Pro endpoints call this query; it requires the dead
// letter table.
JobDeadLetterList(ctx context.Context, params *JobDeadLetterListParams) ([]*JobDeadLetterListResult, error)
// JobDeadLetterAutocomplete returns at most Max distinct values of the
// facet that start with Match and aren't in Exclude. Every driver compares
// and orders values the same way regardless of database collation: Match
// ignores the case of ASCII letters only, and values sort by their UTF-8
// bytes. Only Pro endpoints call this query; it requires the dead letter
// table.
JobDeadLetterAutocomplete(ctx context.Context, params *JobDeadLetterAutocompleteParams) ([]string, error)
}
Executor contains River UI's database operations and embeds River's executor so callers retain transaction and core query support through one value.
type JobCountByAllStatesCappedParams ¶
type JobCountEstimateParams ¶
type JobCountEstimateResult ¶
type JobDeadLetterAutocompleteParams ¶ added in v0.22.0
type JobDeadLetterAutocompleteParams struct {
Exclude []string
Facet JobDeadLetterFacet
Match string
Max int
Schema string
}
func (*JobDeadLetterAutocompleteParams) Validate ¶ added in v0.22.0
func (p *JobDeadLetterAutocompleteParams) Validate() error
Validate reports whether the params are ones that every driver accepts. Drivers call it before querying so they all reject the same inputs.
type JobDeadLetterFacet ¶ added in v0.22.0
type JobDeadLetterFacet string
JobDeadLetterFacet is a job attribute that JobDeadLetterAutocomplete can suggest values for. The queries compare against these values literally.
const ( JobDeadLetterFacetJobKind JobDeadLetterFacet = "job_kind" JobDeadLetterFacetQueueName JobDeadLetterFacet = "queue_name" )
type JobDeadLetterFilters ¶ added in v0.22.0
type JobDeadLetterFilters struct {
IDs []int64 `json:"ids,omitempty"`
Kinds []string `json:"kinds,omitempty"`
Priorities []int16 `json:"priorities,omitempty"`
Queues []string `json:"queues,omitempty"`
Tags []string `json:"tags,omitempty"`
}
JobDeadLetterFilters matches any value within each populated filter and requires all populated filters to match. Tags match any exact tag.
type JobDeadLetterListParams ¶ added in v0.22.0
type JobDeadLetterListParams struct {
Filters JobDeadLetterFilters
Max int
Schema string
}
func (*JobDeadLetterListParams) Validate ¶ added in v0.22.0
func (p *JobDeadLetterListParams) Validate() error
Validate reports whether the params are ones that every driver accepts. Drivers call it before querying so they all reject the same inputs.
type JobDeadLetterListResult ¶ added in v0.22.0
type JobDeadLetterListResult struct {
ID int64 `json:"id"`
Attempt int `json:"attempt"`
FinalizedAt *time.Time `json:"finalized_at"`
Kind string `json:"kind"`
MaxAttempts int `json:"max_attempts"`
Queue string `json:"queue"`
}
JobDeadLetterListResult contains only fields displayed in the list. Args, metadata, and attempt history are loaded separately when opening a job.
FinalizedAt is in UTC. Its precision is the one difference between drivers: PostgreSQL returns microseconds while SQLite returns milliseconds.
Source Files
¶
- river_ui_driver_interface.go
Directories
¶
| Path | Synopsis |
|---|---|
|
Package riveruidrivertest provides a shared conformance suite for River UI database drivers.
|
Package riveruidrivertest provides a shared conformance suite for River UI database drivers. |
|
Package riveruipostgres implements River UI's database operations for PostgreSQL.
|
Package riveruipostgres implements River UI's database operations for PostgreSQL. |
|
Package riveruisqlite implements River UI's database operations for SQLite.
|
Package riveruisqlite implements River UI's database operations for SQLite. |