gonsole

package module

Go to main page

Versions in this module

v0

v0.9.0

Oct 31, 2026

Changes in this version

type Env

+ func (e Env) RuntimeLimits() (RuntimeLimits, error)

+ type RuntimeLimits struct

+ MaxProcs int

+ MemoryLimitMB int

v0.8.0

Oct 15, 2026

Changes in this version

+ func OverSocket(r *http.Request) bool

+ func ServeListening(ctx context.Context, srv *http.Server, t Timeouts, l Listening, ...) error

type Env

+ func (e Env) Listening(fallback Listening) (Listening, error)

+ type Listening struct

+ Address string

+ ClientAddrHeader string

+ IdleExit time.Duration

+ Network string

v0.7.0

Oct 9, 2026

Changes in this version

+ var ErrDescribing = errors.New("gonsole: a describing call opens no database")

type Call

+ func (c Call) DB(ctx context.Context) (*sql.DB, error)

+ func (c Call) WithDB(db *sql.DB) Call

type Program

+ Open func(ctx context.Context, databaseURL string) (*sql.DB, error)

type Step

+ RunOn func(ctx context.Context, db *sql.DB) error

+ func (s Step) Apply(ctx context.Context, address string, db *sql.DB) error

v0.6.1

Oct 7, 2026

v0.6.0

Oct 5, 2026

Changes in this version

type Command

+ Needs []string

v0.5.0

Oct 4, 2026

Changes in this version

type Bound

+ func Entries(fewest, most int) Bound

+ func WholeMilliseconds() Bound

type Env

+ func (e Env) Counts(name string, fallback []int, bounds ...Bound) ([]int, error)

v0.4.0

Oct 3, 2026

Changes in this version

+ func BaseCommands() []string

+ func StopHost(ctx context.Context, host PluginHost, grace time.Duration) error

v0.3.0

Sep 30, 2026

Changes in this version

type Loaded

+ func Hosted[P interface{ ... }](plugins []P, host PluginHost, failed error, grace time.Duration, done func()) Loaded

+ type PluginHost interface

+ Migrate func(ctx context.Context) error

+ Seed func(ctx context.Context) error

+ Stop func(ctx context.Context) error

v0.2.0

Sep 26, 2026

Changes in this version

+ var ErrGraceRanOut = errors.New("gonsole: the shutdown grace ran out")

+ var ErrStillServing = errors.New("gonsole: requests still running after the cancel grace")

type Timeouts

+ CancelGrace time.Duration

+ StopGrace time.Duration

v0.1.0

Sep 25, 2026

Changes in this version

+ const ExitDone

+ const ExitFailed

+ const ExitMisused

+ var ErrMisused = errors.New("gonsole: misused")

+ func Main(p Program) int

+ func Misuse(err error) error

+ func NewServer(addr string, handler http.Handler, t Timeouts) *http.Server

+ func Parse[T any](e Env, name string, fallback T, parse func(string) (T, error)) (T, error)

+ func Serve(ctx context.Context, srv *http.Server, t Timeouts, ...) error

+ type Bound func(*limits)

+ func AllowZero() Bound

+ func AtMost(highest int64) Bound

+ type Call struct

+ Actor string

+ Apply bool

+ Args []string

+ Describe bool

+ Env Env

+ Flags map[string]string

+ JSON bool

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ func (c Call) DatabaseURL() (string, error)

+ func (c Call) Encode(v any) error

+ func (c Call) Plugins(ctx context.Context) (Loaded, error)

+ type Command struct

+ Args []string

+ Capability string

+ Flags func(fs *flag.FlagSet)

+ JSON bool

+ Migrates bool

+ Name string

+ Run func(ctx context.Context, call Call) error

+ Summary string

+ Writes bool

+ type Env struct

+ Getenv func(string) string

+ Prefix string

+ func (e Env) Count(name string, fallback int, bounds ...Bound) (int, error)

+ func (e Env) Duration(name string, fallback time.Duration, bounds ...Bound) (time.Duration, error)

+ func (e Env) Flag(name string, fallback bool) (bool, error)

+ func (e Env) Key(name string) string

+ func (e Env) Required(name string) (string, error)

+ func (e Env) Timeouts(fallback Timeouts) (Timeouts, error)

+ func (e Env) Value(name string) string

+ func (e Env) Within(more string) Env

+ type Group struct

+ Commands []Command

+ Namespace string

+ func Walk[P interface{ ... }](plugins []P) ([]Group, error)

+ type Loaded struct

+ Failed error

+ Groups []Group

+ Migrate func(ctx context.Context) error

+ Release func(ctx context.Context) error

+ Seed func(ctx context.Context) error

+ type Program struct

+ Authorize func(ctx context.Context, call Call, capability string) error

+ BareServes bool

+ Commands []Command

+ Database string

+ Env Env

+ Footer string

+ Lock func(ctx context.Context, databaseURL string) (func(context.Context) error, error)

+ Migrations []Step

+ Name string

+ Plugins func(ctx context.Context, call Call) (Loaded, error)

+ Record func(ctx context.Context, call Call, command string) error

+ Renamed map[string]string

+ Reserved []string

+ Seed func(ctx context.Context, call Call) error

+ Serve func(ctx context.Context, call Call) error

+ Title string

+ Validate func(ctx context.Context, call Call) error

+ Version string

+ func (p Program) Check(loaded Loaded) error

+ func (p Program) Run(ctx context.Context, args []string, stdin io.Reader, stdout, stderr io.Writer) int

+ type Provider interface

+ Commands func() []Command

+ type Step struct

+ Name string

+ Run func(ctx context.Context, databaseURL string) error

+ type Timeouts struct

+ Grace time.Duration

+ Idle time.Duration

+ Read time.Duration

+ ReadHeader time.Duration

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL