datatable

Nov 1, 2026

Changes in this version

type Tickets

+ func TokenTickets[M model.Identifiable, K any](tokens *token.Tokens[M, K]) Tickets[M]

Oct 31, 2026

Changes in this version

+ func DownloadQueryDescriptor() foundryhttp.Query[DownloadQuery]

+ func ExportRequestJSON() foundrycontract.JSON[ExportRequest]

+ func ExportTicketJSON() foundrycontract.JSON[ExportTicket]

+ func Routes[S, R, M, A any](group foundryhttp.Scope, table Table[S, R, A], config RoutesConfig[M, A], ...) ([]foundryhttp.RouteRegistration, error)

+ type DownloadQuery struct

+ Format ExportFormat

+ Locale value.Optional[i18n.LocaleID]

+ Request string

+ Ticket string

+ type ExportRequest struct

+ Format ExportFormat

+ Request Request

+ type ExportRequestValidationFieldSet struct

+ Format foundryvalidation.Field[ExportRequest, ExportFormat]

+ Request foundryvalidation.Field[ExportRequest, Request]

+ func ExportRequestValidationFields() ExportRequestValidationFieldSet

+ type ExportTicket struct

+ ExpiresAt temporal.DateTime

+ URL string

+ type ExportTicketValidationFieldSet struct

+ ExpiresAt foundryvalidation.Field[ExportTicket, temporal.DateTime]

+ URL foundryvalidation.Field[ExportTicket, string]

+ func ExportTicketValidationFields() ExportTicketValidationFieldSet

+ type IssuedTicket struct

+ ExpiresAt temporal.DateTime

+ Secret secret.String

+ type RouteOption struct

+ func ExportAccess[M any](options ...foundryhttp.GuardOption[M]) RouteOption[M]

+ func ReadAccess[M any](options ...foundryhttp.GuardOption[M]) RouteOption[M]

+ type RoutesConfig struct

+ Authority func(context.Context, M) (A, error)

+ Clock clock.Clock

+ Guard foundryhttp.GuardBinding[M]

+ Manager *Manager

+ Quota foundryhttp.Middleware

+ Tickets Tickets[M, A]

+ WithLocale func(A, i18n.LocaleID) A

+ type Tickets struct

+ Issue func(context.Context, M) (IssuedTicket, error)

+ Redeem func(context.Context, secret.String) (A, error)

Oct 31, 2026

Changes in this version

+ func BindFileExport[S, R, A, P, Q, B any](table Table[S, R, A], ...) foundryhttp.Endpoint[P, Q, B, foundryhttp.Download]

+ func BindTicketExport[S, R, A, P, Q, B, T any](table Table[S, R, A], endpoint foundryhttp.Endpoint[P, Q, B, T], ...) foundryhttp.Endpoint[P, Q, B, T]

+ func ColumnKindCodec() codec.Codec[ColumnKind]

+ func DownloadEndpoint[S, R, A, P, Q any](table Table[S, R, A], route foundryhttp.Route[P], query foundryhttp.Query[Q], ...) foundryhttp.Endpoint[P, Q, foundryhttp.NoBody, foundryhttp.Download]

+ func QueryEndpoint[S, R, A, P, Q any](table Table[S, R, A], route foundryhttp.Route[P], query foundryhttp.Query[Q], ...) foundryhttp.Endpoint[P, Q, Request, pagination.NumberedResponse[R]]

type ColumnInfo

+ Kind ColumnKind

+ type ColumnKind string

+ const ColumnBoolean

+ const ColumnDate

+ const ColumnDateTime

+ const ColumnDecimal

+ const ColumnEnum

+ const ColumnInteger

+ const ColumnLocalDateTime

+ const ColumnText

+ const ColumnTime

+ func ColumnKindValues() []ColumnKind

+ func ParseColumnKind(text string) (ColumnKind, error)

+ func (ColumnKind) EnumDescriptor() enum.Descriptor[ColumnKind]

+ func (v *ColumnKind) Scan(source any) error

+ func (v *ColumnKind) UnmarshalJSON(data []byte) error

+ func (v *ColumnKind) UnmarshalText(data []byte) error

+ func (v ColumnKind) IsValid() bool

+ func (v ColumnKind) MarshalJSON() ([]byte, error)

+ func (v ColumnKind) MarshalText() ([]byte, error)

+ func (v ColumnKind) Validate() error

+ func (v ColumnKind) Value() (driver.Value, error)

+ type ColumnOption struct

+ func ExportAs[S, V any](_ expr.Selected[S, V], cell Cell[V]) ColumnOption[S, V]

+ func FilterBy[S, V any](source FilterSource[S, V]) ColumnOption[S, V]

+ func Searchable[S, V any](_ expr.RowValue[S, V]) ColumnOption[S, V]

+ func SortBy[S, V any](expression expr.Selected[S, V]) ColumnOption[S, V]

type Description

+ Page contract.Schema

Oct 27, 2026

Changes in this version

+ const DefaultPageSize

+ const MaxColumns

+ const MaxFilterDepth

+ const MaxFilterValues

+ const MaxFilters

+ const MaxRequestBytes

+ const MaxScalarBytes

+ const MaxSorts

+ func DirectionCodec() codec.Codec[Direction]

+ func ExportFormatCodec() codec.Codec[ExportFormat]

+ func ExportHandler[P, S, R, A any](table Table[S, R, A], manager *Manager, ...) (jobs.Handler[P], error)

+ func ExportOptionsJSON() foundrycontract.JSON[ExportOptions]

+ func FilterJSON() foundrycontract.JSON[Filter]

+ func Module(name foundation.ProviderID, key foundation.Key[*Manager], ...) foundation.Module

+ func OperatorCodec() codec.Codec[Operator]

+ func PresentationJSON() foundrycontract.JSON[Presentation]

+ func RequestJSON() foundrycontract.JSON[Request]

+ func SortJSON() foundrycontract.JSON[Sort]

+ type Action string

+ const ExportAction

+ const InspectAction

+ const QueryAction

+ type Artifact struct

+ func (a *Artifact) Close() error

+ func (a *Artifact) EntityTag() foundryhttp.EntityTag

+ func (a *Artifact) MediaType() foundryhttp.MediaType

+ func (a *Artifact) Modified() time.Time

+ func (a *Artifact) Name() string

+ func (a *Artifact) Read(p []byte) (int, error)

+ func (a *Artifact) Rows() int

+ func (a *Artifact) SHA256() string

+ func (a *Artifact) Seek(offset int64, whence int) (int64, error)

+ func (a *Artifact) Size() int64

+ type Cell struct

+ func NullableCell[V any](codec foundryhttp.QueryCodec[V]) Cell[value.Nullable[V]]

+ func ScalarCell[V any](codec foundryhttp.QueryCodec[V]) Cell[V]

+ func (c Cell[V]) FormatWith(format func(context.Context, V, Presentation) (string, error)) Cell[V]

+ type Column struct

+ func DefineColumn[S, R, V any](field validation.Field[R, V], label i18n.MessageKey) Column[S, R, V]

+ func (c Column[S, R, V]) ExportAs(cell Cell[V]) Column[S, R, V]

+ func (c Column[S, R, V]) FilterBy(source FilterSource[S, V]) Column[S, R, V]

+ func (c Column[S, R, V]) Registration() ColumnRegistration[S, R]

+ func (c Column[S, R, V]) Searchable() Column[S, R, V]

+ func (c Column[S, R, V]) SortBy(expression expr.Selected[S, V]) Column[S, R, V]

+ type ColumnInfo struct

+ Exportable bool

+ Filter *FilterInfo

+ Label i18n.MessageKey

+ Name string

+ SearchOperator Operator

+ Searchable bool

+ Sortable bool

+ Value contract.ScalarProperty

+ type ColumnRegistration struct

+ type Config struct

+ ExportTimeout time.Duration

+ MaxActive int

+ MaxArtifacts int

+ MaxCellBytes int

+ MaxExportBytes int64

+ MaxExportRows int

+ MaxExports int

+ MaxOffset int

+ MaxPageBytes int

+ MaxPageSize int

+ MaxRowBytes int

+ MaxXMLBytes int64

+ Schema string

+ TempDir string

+ TimeZone temporal.ZoneName

+ Timeout time.Duration

+ func DefaultConfig() Config

+ func (c Config) Validate() error

+ type Dependencies struct

+ Database *database.DB

+ Labels Labels

+ Locales i18n.LocaleCatalog

+ type Description struct

+ Columns []ColumnInfo

+ DefaultSort []Sort

+ Exports bool

+ Filters []NamedFilterInfo

+ ID TableID

+ Request contract.Schema

+ Row contract.Schema

+ func (d Description) Normalize() (Description, error)

+ type Direction string

+ const Ascending

+ const Descending

+ func DirectionValues() []Direction

+ func ParseDirection(text string) (Direction, error)

+ func (Direction) EnumDescriptor() enum.Descriptor[Direction]

+ func (v *Direction) Scan(source any) error

+ func (v *Direction) UnmarshalJSON(data []byte) error

+ func (v *Direction) UnmarshalText(data []byte) error

+ func (v Direction) IsValid() bool

+ func (v Direction) MarshalJSON() ([]byte, error)

+ func (v Direction) MarshalText() ([]byte, error)

+ func (v Direction) Validate() error

+ func (v Direction) Value() (driver.Value, error)

+ type ExportFormat string

+ const CSV

+ const XLSX

+ func ExportFormatValues() []ExportFormat

+ func ParseExportFormat(text string) (ExportFormat, error)

+ func (ExportFormat) EnumDescriptor() enum.Descriptor[ExportFormat]

+ func (v *ExportFormat) Scan(source any) error

+ func (v *ExportFormat) UnmarshalJSON(data []byte) error

+ func (v *ExportFormat) UnmarshalText(data []byte) error

+ func (v ExportFormat) IsValid() bool

+ func (v ExportFormat) MarshalJSON() ([]byte, error)

+ func (v ExportFormat) MarshalText() ([]byte, error)

+ func (v ExportFormat) Validate() error

+ func (v ExportFormat) Value() (driver.Value, error)

+ type ExportOptions struct

+ ByteOrderMark bool

+ Format ExportFormat

+ Name string

+ Presentation Presentation

+ type ExportOptionsValidationFieldSet struct

+ ByteOrderMark foundryvalidation.Field[ExportOptions, bool]

+ Format foundryvalidation.Field[ExportOptions, ExportFormat]

+ Name foundryvalidation.Field[ExportOptions, string]

+ Presentation foundryvalidation.Field[ExportOptions, Presentation]

+ func ExportOptionsValidationFields() ExportOptionsValidationFieldSet

+ type Filter struct

+ Children []Filter

+ Column string

+ Op Operator

+ Values []string

+ type FilterInfo struct

+ Nullable bool

+ Operators []Operator

+ Phase FilterPhase

+ Scalar foundryhttp.URLScalarInfo

+ type FilterPhase string

+ const HavingPhase

+ const WherePhase

+ type FilterRegistration struct

+ func DefineFilter[S, V any](name string, label i18n.MessageKey, source FilterSource[S, V]) FilterRegistration[S]

+ type FilterSource struct

+ func Having[S, V any](codec foundryhttp.QueryCodec[V], source GroupEquality[S, V]) FilterSource[S, V]

+ func NullableHaving[S, V any](codec foundryhttp.QueryCodec[V], source GroupNullable[S, V]) FilterSource[S, value.Nullable[V]]

+ func NullableWhere[S, V any](codec foundryhttp.QueryCodec[V], source RowNullable[S, V]) FilterSource[S, value.Nullable[V]]

+ func Related[S, C, V any](source FilterSource[C, V], exists func(expr.Predicate[C]) expr.Predicate[S]) FilterSource[S, V]

+ func Where[S, V any](codec foundryhttp.QueryCodec[V], source RowEquality[S, V]) FilterSource[S, V]

+ func (s FilterSource[S, V]) AllowLike() FilterSource[S, V]

+ func (s FilterSource[S, V]) Description() (FilterInfo, error)

+ func (s FilterSource[S, V]) Restrict(operators ...Operator) FilterSource[S, V]

+ func (s FilterSource[S, V]) Validate() error

+ type FilterValidationFieldSet struct

+ Children foundryvalidation.Field[Filter, []Filter]

+ Column foundryvalidation.Field[Filter, string]

+ Op foundryvalidation.Field[Filter, Operator]

+ Values foundryvalidation.Field[Filter, []string]

+ func FilterValidationFields() FilterValidationFieldSet

+ type GroupEquality interface

+ Eq func(V) expr.HavingPredicate[S]

+ In func(...V) expr.HavingPredicate[S]

+ Ne func(V) expr.HavingPredicate[S]

+ type GroupNullable interface

+ IsNotNull func() expr.HavingPredicate[S]

+ IsNull func() expr.HavingPredicate[S]

+ type Labels func(context.Context, i18n.LocaleID, i18n.MessageKey) (string, error)

+ type Manager struct

+ func New(dependencies Dependencies, config Config, registrations ...Registration) (*Manager, error)

+ func (m *Manager) Close(ctx context.Context) error

+ func (m *Manager) DoneExports() <-chan struct{}

+ func (m *Manager) DoneQueries() <-chan struct{}

+ func (m *Manager) DownloadTimeout() time.Duration

+ func (m *Manager) Registry() *Registry

+ func (m *Manager) Validate() error

+ type NamedFilterInfo struct

+ Filter FilterInfo

+ Label i18n.MessageKey

+ Name string

+ type Operator string

+ const All

+ const Any

+ const Between

+ const Contains

+ const Equal

+ const Greater

+ const GreaterEqual

+ const In

+ const InsensitiveContains

+ const IsNotNull

+ const IsNull

+ const Less

+ const LessEqual

+ const Like

+ const Not

+ const NotEqual

+ const NotIn

+ func OperatorValues() []Operator

+ func ParseOperator(text string) (Operator, error)

+ func (Operator) EnumDescriptor() enum.Descriptor[Operator]

+ func (v *Operator) Scan(source any) error

+ func (v *Operator) UnmarshalJSON(data []byte) error

+ func (v *Operator) UnmarshalText(data []byte) error

+ func (v Operator) IsValid() bool

+ func (v Operator) MarshalJSON() ([]byte, error)

+ func (v Operator) MarshalText() ([]byte, error)

+ func (v Operator) Validate() error

+ func (v Operator) Value() (driver.Value, error)

+ type Presentation struct

+ Locale i18n.LocaleID

+ TimeZone string

+ func (p Presentation) Location() (*time.Location, error)

+ type PresentationValidationFieldSet struct

+ Locale foundryvalidation.Field[Presentation, i18n.LocaleID]

+ TimeZone foundryvalidation.Field[Presentation, string]

+ func PresentationValidationFields() PresentationValidationFieldSet

+ type Registration struct

+ type Registry struct

+ func NewRegistry(registrations ...Registration) (*Registry, error)

+ func (r *Registry) Descriptions() ([]Description, error)

+ func (r *Registry) Validate() error

+ type Request struct

+ Filters []Filter

+ Page int

+ Search string

+ Size int

+ Sort []Sort

+ func DecodeRequest(ctx context.Context, data []byte) (Request, error)

+ type RequestValidationFieldSet struct

+ Filters foundryvalidation.Field[Request, []Filter]

+ Page foundryvalidation.Field[Request, int]

+ Search foundryvalidation.Field[Request, string]

+ Size foundryvalidation.Field[Request, int]

+ Sort foundryvalidation.Field[Request, []Sort]

+ func RequestValidationFields() RequestValidationFieldSet

+ type RowEquality interface

+ Eq func(V) expr.Predicate[S]

+ In func(...V) expr.Predicate[S]

+ Ne func(V) expr.Predicate[S]

+ type RowNullable interface

+ IsNotNull func() expr.Predicate[S]

+ IsNull func() expr.Predicate[S]

+ type Sort struct

+ Column string

+ Direction Direction

+ type SortValidationFieldSet struct

+ Column foundryvalidation.Field[Sort, string]

+ Direction foundryvalidation.Field[Sort, Direction]

+ func SortValidationFields() SortValidationFieldSet

+ type Spec struct

+ Authorize func(context.Context, A, Action) error

+ Columns []ColumnRegistration[S, R]

+ DefaultSort []Sort

+ Exports bool

+ Filters []FilterRegistration[S]

+ ID TableID

+ Row contract.JSON[R]

+ Source func(context.Context, A) (rows.Query[S, R], error)

+ Stable []expr.ProjectionOrder[S]

+ type Table struct

+ func Define[S, R, A any](spec Spec[S, R, A]) Table[S, R, A]

+ func (t Table[S, R, A]) Count(ctx context.Context, m *Manager, subject A, request Request) (int64, error)

+ func (t Table[S, R, A]) Description() (Description, error)

+ func (t Table[S, R, A]) Download(ctx context.Context, m *Manager, subject A, request Request, ...) (foundryhttp.Download, error)

+ func (t Table[S, R, A]) Export(ctx context.Context, m *Manager, subject A, request Request, ...) (result *Artifact, err error)

+ func (t Table[S, R, A]) ID() TableID

+ func (t Table[S, R, A]) Inspect(ctx context.Context, m *Manager, subject A) (Description, error)

+ func (t Table[S, R, A]) Query(ctx context.Context, m *Manager, subject A, request Request) (orm.PageResult[R], error)

+ func (t Table[S, R, A]) Registration() Registration

+ func (t Table[S, R, A]) SimpleQuery(ctx context.Context, m *Manager, subject A, request Request) (orm.SimplePage[R], error)

+ func (t Table[S, R, A]) Validate() error

+ type TableID string