profilestore

type BeforeExecuteFunc ¶

type BeforeExecuteFunc func(ctx context.Context, reads []ReadRequest) (release func(), err error)

BeforeExecuteFunc prepares one or more profile reads and returns the release that keeps their data readable. The caller holds release until every read in the batch has finished. Its error fails the whole batch; nothing is read after it.

It is the seam a data source that has to be prepared per request plugs into — a record stream index caught up to its source before the index is paged. A hook may rewrite a read's Params (see ReadRequest), and must leave a map it already rewrote as it is when it prepares that map again.

type ReadRequest ¶

type ReadRequest struct {
	Profile query.Profile
	Params  map[string]any
}

ReadRequest is one resolved profile read and the parameters the caller supplied, unresolved. Params is the map the caller executes the read with, and a hook may rewrite it in place: a data source that indexes what a caller names under another id — a routed record stream — binds that id, which only the hook, running under the request's context, can resolve.

type Store ¶

type Store interface {
	List(context.Context) ([]query.Profile, error)
	Get(context.Context, string) (query.Profile, error)
	Save(context.Context, query.Profile) error
	Update(context.Context, string, query.Profile, UpdateOptions) error
	Delete(context.Context, string) error
}

type UpdateOptions ¶

type UpdateOptions struct {
	ReplaceExisting bool
}

type VirtualStore ¶

type VirtualStore interface {
	Store
	Peek(context.Context, string) (query.Profile, error)
	IsVirtual(string) bool
}