maniflex

package module

Go to main page

Versions in this module

v0

v0.4.2

Jul 30, 2026

Changes in this version

type Config

+ RequestObservers []RequestObserver

+ type PresignURLOptions struct

+ Download bool

+ Filename string

+ ResponseCacheControl string

+ ResponseContentDisposition string

+ ResponseContentEncoding string

+ ResponseContentLanguage string

+ ResponseContentType string

+ ResponseExpires time.Time

+ TTL time.Duration

+ VersionID string

+ func (o PresignURLOptions) ContentDisposition() string

+ type RequestObservation struct

+ Actor string

+ Duration time.Duration

+ Method string

+ Model string

+ Operation Operation

+ Path string

+ RequestID string

+ ResourceID string

+ RoutePattern string

+ StartedAt time.Time

+ Status int

+ TraceID string

+ type RequestObserver func(RequestObservation)

type Server

+ func (c *Server) ObserveRequests(observers ...RequestObserver)

v0.4.1

Jul 29, 2026

Changes in this version

+ var ErrAlreadyStarted = errors.New("maniflex: server already started")

+ var ErrRegistrationClosed = errors.New("maniflex: registration is closed")

+ var ErrStopped = errors.New("maniflex: server has stopped")

type Server

+ func (c *Server) StartServices() error

v0.4.0

Jul 28, 2026

Changes in this version

type ActionConfig

+ AccessControlled bool

+ AllowPublic bool

+ type BlindIndexKeyProvider interface

+ BlindIndexKeyID func() string

type Config

+ Documentation DocumentationConfig

+ HTTPAccessControlled bool

+ HTTPMiddlewares []HTTPMiddleware

+ QueryLimits QueryLimits

+ type DocumentationConfig struct

+ Middleware []HTTPMiddleware

+ Public bool

+ type EncryptionRotationError struct

+ Failures []EncryptionRotationFailure

+ func (e *EncryptionRotationError) Error() string

+ func (e *EncryptionRotationError) Unwrap() error

+ type EncryptionRotationFailure struct

+ Err error

+ Field string

+ RowID string

+ Stage string

+ func (f EncryptionRotationFailure) Error() string

+ type EncryptionRotationOptions struct

+ AfterID string

+ PageSize int

+ type EncryptionRotationReport struct

+ Complete bool

+ Failures []EncryptionRotationFailure

+ LastID string

+ Model string

+ NewKeyID string

+ OldKeyID string

+ Rotated int

+ Scanned int

+ StartedAfterID string

+ func RotateEncryptionKeyWithOptions(ctx context.Context, s *Server, modelName, oldKeyID, newKeyID string, ...) (report EncryptionRotationReport, err error)

type FilesConfig

+ AllowPublic bool

type GlobalSearchConfig

+ AllowPublic bool

+ type HTTPMiddleware func(http.Handler) http.Handler

+ func AdaptAuth(middleware ...MiddlewareFunc) HTTPMiddleware

type ModelConfig

+ QueryLimits QueryLimits

+ type QueryLimits struct

+ DefaultAggregateRows int

+ MaxAggregateFilters int

+ MaxAggregateGroupFields int

+ MaxAggregateHaving int

+ MaxAggregateRows int

+ MaxAggregateSelectFields int

+ MaxAggregateSortFields int

+ MaxFilterClauses int

+ MaxFilterGroups int

+ MaxFiltersPerGroup int

+ MaxIncludes int

+ MaxSelectFields int

+ MaxSortFields int

+ MaxURLBytes int

type Server

+ func (c *Server) AllowPublic(opts ...MiddlewareOption)

+ func (c *Server) ValidateProduction() error

v0.3.4

Jul 24, 2026

v0.3.3

Jul 23, 2026

v0.3.2

Jul 22, 2026

Changes in this version

+ const CanonicalTimeLayout

+ func CanonicalTime(t time.Time) string

v0.3.1

Jul 20, 2026

Changes in this version

+ func RedactRecord(model *ModelMeta, v any) any

type ServerContext

+ func (c *ServerContext) AfterCommit(fn func()) bool

v0.3.0

Jul 20, 2026

Changes in this version

+ const MaxIncludeDepth

type ErrConstraint

+ Columns []string

type MiddlewareConfig

+ ProvidesScope bool

type MiddlewareOption

+ func ProvidesScope() MiddlewareOption

type QueryParams

+ NestedIncludes map[string][]string

type ServerContext

+ func (c *ServerContext) ResolveResourceID() string

+ func (c *ServerContext) ServerSetField(jsonName string) bool

v0.2.6

Jul 19, 2026

Changes in this version

type FieldTags

+ MalformedOpts []string

+ type JunctionModel struct

type ModelConfig

+ DisableAutoJunction bool

+ Junction bool

+ JunctionUnique bool

+ VersionedRequired bool

v0.2.5

Jul 19, 2026

Changes in this version

+ const DefaultRecursiveMaxDepth

+ func FoldLocaleScalar(raw []byte) (map[string]string, bool)

type ServerContext

+ func (c *ServerContext) IsFieldRedacted(jsonName string) bool

+ func (c *ServerContext) RedactResponseField(jsonNames ...string)

+ type WriteOption func(*writeOptions)

+ func SkipValidation() WriteOption

v0.2.4

Jul 19, 2026

Changes in this version

type Config

+ Strict bool

type FieldTags

+ StreamUpload bool

+ type ForeignKeySpec struct

+ Column string

+ Name string

+ OnDelete OnDeleteAction

+ RefColumn string

+ RefTable string

+ func ForeignKeysFor(reg RegistryAccessor, m *ModelMeta) []ForeignKeySpec

type MiddlewareConfig

+ RequiredFields []string

type MiddlewareOption

+ func RequiresField(names ...string) MiddlewareOption

type ModelConfig

+ RestoreEnabled bool

type Operation

+ const OpReadHistory

+ type RangeRetriever interface

+ RetrieveRange func(ctx context.Context, key string, offset, length int64) (io.ReadCloser, FileMeta, error)

+ type Restorer interface

+ Restore func(ctx context.Context, model *ModelMeta, id string, q *QueryParams) (any, error)

+ type ScopeChecker interface

+ ExistsInScope func(ctx context.Context, model *ModelMeta, id string, filters []*FilterExpr) (bool, error)

type ServerContext

+ func (c *ServerContext) IsRestore() bool

v0.2.3

Jul 18, 2026

Changes in this version

+ const DefaultMaxFileCount

+ var ErrPresignUnsupported = errors.New("storage backend cannot presign uploads")

+ func AddBatchComputedField[T any](s *Server, modelName, name string, ...) error

+ type ActionScope struct

+ Filters []*FilterExpr

+ Name string

+ type BatchComputedFunc func(ctx *ServerContext, rows []map[string]any) ([]any, error)

type ComputedField

+ Schema *OASSchema

+ type ComputedOption func(*ComputedField)

+ func ComputedSchema(s *OASSchema) ComputedOption

+ type ExecuteError struct

+ Code string

+ Message string

+ Response *APIResponse

+ StatusCode int

+ func (e *ExecuteError) Error() string

type FieldMeta

+ func (f FieldMeta) IsFileList() bool

type FieldTags

+ MaxCount int

+ PresignedUpload bool

+ UnknownOpts []string

+ type FileKeys []string

+ func (FileKeys) SQLType(driver DriverType) string

+ func (FileKeys) Schema() *OASSchema

+ func (fk *FileKeys) Scan(src any) error

+ func (fk FileKeys) Value() (driver.Value, error)

type FileStorage

+ PresignUpload func(ctx context.Context, key string, opts PresignUploadOptions) (*PresignedUpload, error)

+ Stat func(ctx context.Context, key string) (FileMeta, error)

type FilesConfig

+ KeyScope func(ctx *ServerContext) string

type FilterExpr

+ Forced bool

type FilterOperator

+ func (o FilterOperator) Valid() bool

+ type Invocation struct

+ Auth *AuthInfo

+ Body any

+ Header http.Header

+ ID string

+ Model string

+ Operation Operation

+ Query url.Values

+ Tx Tx

type Operation

+ const OpPresignUpload

+ type PresignUploadOptions struct

+ ContentType string

+ Filename string

+ MaxSize int64

+ TTL time.Duration

+ type PresignedUpload struct

+ ExpiresAt time.Time

+ Fields map[string]string

+ Headers map[string]string

+ Key string

+ MaxSize int64

+ Method string

+ URL string

+ type Rollup struct

+ Child string

+ ChildField string

+ On string

+ Op AggregateOp

+ Parent string

+ ParentField string

type Server

+ func (c *Server) Execute(ctx context.Context, inv Invocation) (*APIResponse, error)

+ func (s *Server) AddBatchComputedField(modelName, name string, fn BatchComputedFunc, opts ...ComputedOption) error

+ func (s *Server) BackfillRollups(ctx context.Context) error

+ func (s *Server) MustAddBatchComputedField(modelName, name string, fn BatchComputedFunc, opts ...ComputedOption)

+ func (s *Server) MustRegisterRollup(r Rollup)

+ func (s *Server) RegisterRollup(r Rollup) error

type ServerContext

+ func (c *ServerContext) ActionScope() *ActionScope

+ func (c *ServerContext) EnsureRawBody() ([]byte, error)

+ func (c *ServerContext) InProcess() bool

+ func (c *ServerContext) SetActionScope(s *ActionScope)

+ func (c *ServerContext) Unscoped() *UnscopedContext

+ func (c *ServerContext) ViaFilter(relationKey, parentField string, value any) (*FilterExpr, error)

+ type UnscopedContext struct

+ func (u *UnscopedContext) BeginTx(ctx context.Context, opts *TxOptions) (Tx, error)

+ func (u *UnscopedContext) GetModel(modelName string) *ModelAccessor

+ func (u *UnscopedContext) RawExec(query string, args ...any) (int64, error)

+ func (u *UnscopedContext) RawQuery(query string, args ...any) ([]Row, error)

+ func (u *UnscopedContext) Search(opts SearchOptions) ([]SearchResult, error)

v0.2.2

Jul 16, 2026

Changes in this version

+ const DefaultMaxConcurrentExports

type Config

+ MaxConcurrentExports int

v0.2.1

Jul 16, 2026

Changes in this version

type Config

+ IdleTimeout time.Duration

+ ReadHeaderTimeout time.Duration

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

v0.1.5

Jul 13, 2026

Changes in this version

+ const DefaultMaxUploadBytes

+ const DefaultMaxUploadMemory

+ const LikeEscapeChar

+ const StatusClientClosedRequest

+ var ErrRawNotSupportedInTx = errors.New(...)

+ func LikePattern(op FilterOperator, value any) string

type FilesConfig

+ MaxUploadBytes int64

+ MaxUploadMemory int64

type FilterOperator

+ const OpContains

+ const OpEndsWith

+ const OpStartsWith

type ServerContext

+ func (c *ServerContext) SetMaxBodySize(limit int64)

v0.1.4

Jul 8, 2026

Changes in this version

type Config

+ TrustProxyHeaders bool

+ type ObjectWithSchema interface

+ Schema func() *OASSchema

v0.1.3

Jul 6, 2026

Changes in this version

+ func DefaultKeyGen(_ *ServerContext, header *multipart.FileHeader) string

type Config

+ DisableAutoMigrate bool

+ FilesConfig FilesConfig

type FieldTags

+ RelationInfer bool

+ type FilesConfig struct

+ AfterMiddlewares []MiddlewareFunc

+ BeforeMiddlewares []MiddlewareFunc

+ KeyGen func(ctx *ServerContext, header *multipart.FileHeader) string

+ MountEndpoints bool

+ SignedURLTTL time.Duration

+ Storage FileStorage

type Server

+ func (c *Server) KeyProvider() KeyProvider

type ServerContext

+ func (c *ServerContext) SetKeyProvider(kp KeyProvider)

v0.1.2

Jun 20, 2026

Changes in this version

+ type ConstraintKind string

+ const ConstraintForeignKey

+ const ConstraintNotNull

+ const ConstraintUnique

type ErrConstraint

+ Kind ConstraintKind

type ModelConfig

+ Headless bool

type RelationMeta

+ Convention bool

v0.1.1

Jun 16, 2026

v0.1.0

Jun 15, 2026

Changes in this version

+ const ALPHANUM

+ const DIGITS

+ const DefaultMaxExportRows

+ const LOWER

+ const LOWER_D

+ const SingletonID

+ const TABLE_NAME_PREFIX

+ const UPPER

+ const UPPER_D

+ var ErrFileNotFound = errors.New("file not found")

+ var ErrNoAdapter = errNoAdapter("maniflex: no database adapter configured")

+ var ErrNotFound = errors.New("record not found")

+ func AddComputedField[T any](s *Server, modelName, name string, ...) error

+ func Batch(ctx *ServerContext, fn func(*Batcher) error) error

+ func Bind[T any](ctx *ServerContext) (*T, error)

+ func Create[T any](ctx *ServerContext, record *T) (*T, error)

+ func DecodeCursor(token string) (value any, id string, err error)

+ func Delete[T any](ctx *ServerContext, id string) error

+ func EncodeCursor(value any, id string) string

+ func ExtraColumns(record any) map[string]any

+ func For[T any](ctx *ServerContext) (*T, bool)

+ func FormatDuration(d time.Duration) string

+ func List[T any](ctx *ServerContext, q *QueryParams) ([]*T, error)

+ func MapToRecord(model *ModelMeta, m map[string]any) (any, error)

+ func Migrate(s *Server, migrations []Migration) error

+ func Mount(r chi.Router, services ...*Server)

+ func PanicRecoverer(logger *slog.Logger) func(http.Handler) http.Handler

+ func PresentColumns(record any) map[string]struct

+ func RandomString(length int, charset string) string

+ func Read[T any](ctx *ServerContext, id string) (*T, error)

+ func RecordToMap(model *ModelMeta, record any) map[string]any

+ func ResolveManyToManyForTest(reg *Registry) error

+ func RotateEncryptionKey(ctx context.Context, s *Server, modelName, oldKeyID, newKeyID string) (rotated int, err error)

+ func SetExtra(record any, m map[string]any)

+ func SetPresentColumns(record any, cols []string)

+ func SplitCSV(s string) []string

+ func Update[T any](ctx *ServerContext, id string, record *T) (*T, error)

+ type APIError struct

+ Code string

+ Details any

+ Message string

+ type APIResponse struct

+ AsIs bool

+ Data any

+ Dir string

+ Error *APIError

+ Meta *ResponseMeta

+ StatusCode int

+ func (r *APIResponse) Write(w http.ResponseWriter)

+ type ActionConfig struct

+ Deprecated bool

+ Handler ActionHandlerFunc

+ Method string

+ Middleware []MiddlewareFunc

+ OpenAPI ActionOpenAPI

+ Path string

+ RequestBody *OASRequestBody

+ ResponseMiddleware []MiddlewareFunc

+ Responses map[int]*OASSchema

+ Summary string

+ Tags []string

+ type ActionHandlerFunc func(ctx *ServerContext) error

+ type ActionOpenAPI struct

+ Description string

+ QueryParams []OASParameter

+ RequestSchema any

+ ResponseSchema any

+ ResponseStatus int

+ Security []map[string][]string

+ type AggregateField struct

+ As string

+ Field string

+ Op AggregateOp

+ type AggregateOp string

+ const AggAvg

+ const AggCount

+ const AggCountDistinct

+ const AggMax

+ const AggMin

+ const AggSum

+ type AggregateQuery struct

+ GroupBy []string

+ Having []HavingClause

+ Limit int

+ OrderBy []SortExpr

+ Select []AggregateField

+ Where []*FilterExpr

+ type AsyncAPIChannel struct

+ Description string

+ Publish *AsyncAPIOperation

+ Subscribe *AsyncAPIOperation

+ type AsyncAPIComponents struct

+ Messages map[string]*AsyncAPIMessage

+ Schemas map[string]*OASSchema

+ type AsyncAPIConfig struct

+ AutoModelEvents bool

+ Events []EventDoc

+ Servers []AsyncAPIServerConfig

+ Title string

+ Version string

+ type AsyncAPIInfo struct

+ Description string

+ Title string

+ Version string

+ type AsyncAPIMessage struct

+ ContentType string

+ Description string

+ Name string

+ Payload *OASSchema

+ Summary string

+ Title string

+ type AsyncAPIMessageRef struct

+ Ref string

+ type AsyncAPIOperation struct

+ Description string

+ Message *AsyncAPIMessageRef

+ OperationID string

+ Summary string

+ type AsyncAPIServer struct

+ Description string

+ Protocol string

+ URL string

+ type AsyncAPIServerConfig struct

+ Description string

+ Name string

+ Protocol string

+ URL string

+ type AsyncAPISpec struct

+ AsyncAPI string

+ Channels map[string]AsyncAPIChannel

+ Components AsyncAPIComponents

+ Info AsyncAPIInfo

+ Servers map[string]AsyncAPIServer

+ func GenerateAsyncAPI(reg RegistryAccessor, cfg *Config, asyncCfg AsyncAPIConfig) *AsyncAPISpec

+ type AuthIdentityType string

+ const IdentityAnonymous

+ const IdentityHuman

+ const IdentityServiceAccount

+ type AuthInfo struct

+ AuthMethod string

+ Claims map[string]any

+ IdentityType AuthIdentityType

+ Roles []string

+ Scopes []string

+ SessionID string

+ TenantID string

+ UserID string

+ type BaseModel struct

+ CreatedAt time.Time

+ ID string

+ UpdatedAt time.Time

+ type Batcher struct

+ func (b *Batcher) Create(model string, data map[string]any) (map[string]any, error)

+ func (b *Batcher) Delete(model string, id string) error

+ func (b *Batcher) List(model string, q *QueryParams) ([]map[string]any, error)

+ func (b *Batcher) Model(name string) *ModelAccessor

+ func (b *Batcher) Read(model string, id string) (map[string]any, error)

+ func (b *Batcher) Update(model string, id string, data map[string]any) (map[string]any, error)

+ type CacheStore interface

+ Delete func(ctx context.Context, key string)

+ Get func(ctx context.Context, key string) (any, bool)

+ Set func(ctx context.Context, key string, value any, ttl time.Duration)

+ type ComputedField struct

+ Fn ComputedFunc

+ Name string

+ type ComputedFunc func(ctx context.Context, row map[string]any) (any, error)

+ type Config struct

+ AutoMigrate bool

+ DB DBAdapter

+ DBReadURL string

+ DBWriteURL string

+ FileMiddleware []MiddlewareFunc

+ FileSignedURLTTL time.Duration

+ FileStorage FileStorage

+ HealthCheckDB bool

+ HealthTimeout time.Duration

+ KeyProvider KeyProvider

+ Logger *slog.Logger

+ OnShutdown func(ctx context.Context) error

+ OnStart func(ctx context.Context) error

+ PanicLogger *slog.Logger

+ PathPrefix string

+ Port int

+ QueryTimeout time.Duration

+ ServiceName string

+ ShutdownTimeout time.Duration

+ StaticDir string

+ StaticDisabled bool

+ StaticPrefix string

+ Trace PipelineTrace

+ func ConfigFromEnv(prefix string) Config

+ func (c *Config) ApplyDefaults()

+ type CursorParams struct

+ AfterID string

+ AfterValue any

+ Direction SortDir

+ Field string

+ HasMore bool

+ HasToken bool

+ NextCursor string

+ type DBAdapter interface

+ AutoMigrate func(ctx context.Context, reg RegistryAccessor) error

+ BeginTx func(ctx context.Context, opts *TxOptions) (Tx, error)

+ Close func() error

+ Create func(ctx context.Context, model *ModelMeta, record any) (any, error)

+ Delete func(ctx context.Context, model *ModelMeta, id string) error

+ FindByID func(ctx context.Context, model *ModelMeta, id string, q *QueryParams) (any, error)

+ FindByIDForUpdate func(ctx context.Context, model *ModelMeta, id string) (any, error)

+ FindMany func(ctx context.Context, model *ModelMeta, q *QueryParams) ([]any, int64, error)

+ Raw func(ctx context.Context, query string, args ...any) RawResult

+ Update func(ctx context.Context, model *ModelMeta, id string, record any, ...) (any, error)

+ type DriverType int

+ const Postgres

+ const SQLite

+ type ErrConstraint struct

+ Column string

+ Detail string

+ Table string

+ func (e *ErrConstraint) Error() string

+ type EventDoc struct

+ Description string

+ Payload any

+ Title string

+ Type string

+ type ExportFormat string

+ const ExportFormatCSV

+ const ExportFormatXLSX

+ type FieldMeta struct

+ Index []int

+ Name string

+ Tags FieldTags

+ Type reflect.Type

+ type FieldTags struct

+ Accept []string

+ AutoDelete bool

+ CursorField string

+ DBName string

+ Default string

+ Encrypted bool

+ EncryptionKey string

+ Enum []string

+ File bool

+ FileACL FileACLMode

+ Filterable bool

+ Hidden bool

+ Ignore bool

+ Immutable bool

+ Index bool

+ JSONName string

+ Locale bool

+ LocaleDefault string

+ LocaleMode LocaleMode

+ LocaleModeConflict bool

+ LockScope string

+ LockWhen []LockCondition

+ Max *float64

+ MaxSize int64

+ Min *float64

+ NoRelation bool

+ OmitEmpty bool

+ OnDelete OnDeleteAction

+ Readonly bool

+ Relation string

+ Required bool

+ SchedBadOpt string

+ SchedField string

+ SchedFrom string

+ SchedHard bool

+ SchedHasFrom bool

+ SchedHasTo bool

+ SchedSoft bool

+ SchedTo string

+ Scheduled bool

+ Searchable bool

+ Sortable bool

+ Through string

+ Unique bool

+ WriteOnly bool

+ type FileACLMode string

+ const DefaultFileSignedURLTTL

+ const FileACLPrivate

+ const FileACLPublic

+ const FileACLSigned

+ type FileMeta struct

+ ContentType string

+ Filename string

+ Key string

+ Size int64

+ type FileStorage interface

+ Delete func(ctx context.Context, key string) error

+ Exists func(ctx context.Context, key string) (bool, error)

+ Retrieve func(ctx context.Context, key string) (io.ReadCloser, FileMeta, error)

+ Store func(ctx context.Context, key string, r io.Reader, meta FileMeta) error

+ URL func(ctx context.Context, key string, ttl time.Duration) (string, error)

+ type FilterExpr struct

+ Field string

+ Group int

+ IsLocale bool

+ IsNested bool

+ LocaleKey string

+ NestedField string

+ Operator FilterOperator

+ RelationFK string

+ RelationKey string

+ RelationModel string

+ RelationTable string

+ Value any

+ func ParseFilterParam(raw string, model *ModelMeta, reg RegistryAccessor) (*FilterExpr, error)

+ type FilterOperator string

+ const OpBetween

+ const OpEq

+ const OpGt

+ const OpGte

+ const OpILike

+ const OpIn

+ const OpIsNull

+ const OpLike

+ const OpLt

+ const OpLte

+ const OpNeq

+ const OpNotIn

+ const OpNotNull

+ type GlobalSearchConfig struct

+ DefaultLimit int

+ MaxLimit int

+ Path string

+ type HavingClause struct

+ Alias string

+ Operator FilterOperator

+ Value any

+ type IndexSpec struct

+ Columns []string

+ Name string

+ Unique bool

+ type KeyProvider interface

+ Decrypt func(ctx context.Context, envelope []byte) ([]byte, error)

+ Encrypt func(ctx context.Context, keyID string, plaintext []byte) ([]byte, error)

+ HMAC func(ctx context.Context, keyID string, data []byte) ([]byte, error)

+ KeyIDOf func(envelope []byte) (string, error)

+ type ListResult struct

+ Items []any

+ Query *QueryParams

+ Total int64

+ type LocaleMode string

+ const LocaleModeDynamic

+ const LocaleModeResolve

+ const LocaleModeSplit

+ type LocaleOptions struct

+ Default string

+ DefaultLocaleMode LocaleMode

+ FromHeader bool

+ RTL []string

+ SplitSuffix string

+ Supported []string

+ type LocaleString map[string]string

+ func (LocaleString) SQLType(driver DriverType) string

+ func (ls *LocaleString) UnmarshalJSON(data []byte) error

+ func (ls LocaleString) MarshalJSON() ([]byte, error)

+ type LockCondition struct

+ JSONName string

+ Value string

+ type LockScopeSpec struct

+ DBName string

+ Model string

+ type MemoryCache struct

+ func NewMemoryCache() *MemoryCache

+ func (m *MemoryCache) Delete(_ context.Context, key string)

+ func (m *MemoryCache) Get(_ context.Context, key string) (any, bool)

+ func (m *MemoryCache) Set(_ context.Context, key string, value any, ttl time.Duration)

+ type MiddlewareConfig struct

+ Models []string

+ Name string

+ Operations []Operation

+ Position Position

+ type MiddlewareFunc func(ctx *ServerContext, next func() error) error

+ func Handle[T any](fn func(ctx *ServerContext, record *T) error) MiddlewareFunc

+ func LocaleResolver(opts LocaleOptions) MiddlewareFunc

+ func WithTransaction(opts *TxOptions) MiddlewareFunc

+ type MiddlewareOption func(*MiddlewareConfig)

+ func AtPosition(p Position) MiddlewareOption

+ func ForModel(names ...string) MiddlewareOption

+ func ForOperation(ops ...Operation) MiddlewareOption

+ func WithName(name string) MiddlewareOption

+ type Migration struct

+ NoTransaction bool

+ Up func(ctx context.Context, tx *sql.Tx) error

+ Version string

+ type ModelAccessor struct

+ func (a *ModelAccessor) Create(data map[string]any) (map[string]any, error)

+ func (a *ModelAccessor) Delete(id string) error

+ func (a *ModelAccessor) List(q *QueryParams) ([]map[string]any, error)

+ func (a *ModelAccessor) Read(id string) (map[string]any, error)

+ func (a *ModelAccessor) Update(id string, data map[string]any) (map[string]any, error)

+ type ModelConfig struct

+ Adapter DBAdapter

+ AggregateEnabled bool

+ CursorField string

+ DefaultLocale string

+ DefaultLocaleMode LocaleMode

+ ExportEnabled bool

+ GlobalSearchable bool

+ Indices []IndexSpec

+ MaxExportRows int

+ Middleware *ModelMiddleware

+ OptimisticLock bool

+ SearchLanguage string

+ Singleton bool

+ SoftDelete SoftDeleteConfig

+ TableName string

+ Versioned bool

+ VersionedDiffOnly bool

+ type ModelMeta struct

+ Adapter DBAdapter

+ Computed []ComputedField

+ Config ModelConfig

+ CursorField string

+ Fields []FieldMeta

+ GoType reflect.Type

+ Indices []IndexSpec

+ LockScopes []LockScopeSpec

+ LockWhen []LockCondition

+ Name string

+ Relations []RelationMeta

+ SearchFields []string

+ SoftDelete SoftDeleteConfig

+ TableName string

+ func ScanModel(v any, cfg ModelConfig) (*ModelMeta, error)

+ func (m *ModelMeta) EncryptedFields() []FieldMeta

+ func (m *ModelMeta) FieldByDBName(name string) *FieldMeta

+ func (m *ModelMeta) FieldByJSONName(name string) *FieldMeta

+ func (m *ModelMeta) FileFields() []FieldMeta

+ func (m *ModelMeta) FilterableDBNames() map[string]bool

+ func (m *ModelMeta) HasEncryptedFields() bool

+ func (m *ModelMeta) HasFileFields() bool

+ func (m *ModelMeta) HasScheduled() bool

+ func (m *ModelMeta) RelationByKey(key string) *RelationMeta

+ func (m *ModelMeta) RelationByModel(name string) *RelationMeta

+ func (m *ModelMeta) ResolveAdapter(global DBAdapter) DBAdapter

+ func (m *ModelMeta) Scheduled() []ScheduledSpec

+ type ModelMiddleware struct

+ Auth []MiddlewareFunc

+ DB []MiddlewareFunc

+ Deserialize []MiddlewareFunc

+ Response []MiddlewareFunc

+ Service []MiddlewareFunc

+ Validate []MiddlewareFunc

+ type OASEncoding struct

+ ContentType string

+ type OASMediaType struct

+ Encoding map[string]OASEncoding

+ Schema *OASSchema

+ type OASOperation struct

+ Deprecated bool

+ Description string

+ OperationID string

+ Parameters []OASParameter

+ RequestBody *OASRequestBody

+ Responses map[string]OASResponse

+ Security []map[string][]string

+ Summary string

+ Tags []string

+ type OASParameter struct

+ Description string

+ Explode *bool

+ In string

+ Name string

+ Required bool

+ Schema *OASSchema

+ Style string

+ type OASRequestBody struct

+ Content map[string]OASMediaType

+ Description string

+ Required bool

+ func JSONRequestBody(schema *OASSchema) *OASRequestBody

+ type OASResponse struct

+ Content map[string]OASMediaType

+ Description string

+ type OASSchema struct

+ AdditionalProperties *bool

+ AllOf []*OASSchema

+ AnyOf []*OASSchema

+ Description string

+ Enum []any

+ Format string

+ Items *OASSchema

+ MaxLength *int

+ Maximum *float64

+ MinLength *int

+ Minimum *float64

+ OneOf []*OASSchema

+ Properties map[string]*OASSchema

+ ReadOnly bool

+ Ref string

+ Required []string

+ Type any

+ WriteOnly bool

+ type OASSecurityScheme struct

+ BearerFormat string

+ Description string

+ In string

+ Name string

+ Scheme string

+ Type string

+ type OnDeleteAction string

+ const OnDeleteCascade

+ const OnDeleteNoAction

+ const OnDeleteRestrict

+ const OnDeleteSetNull

+ type OpenAPIComponents struct

+ Schemas map[string]*OASSchema

+ SecuritySchemes map[string]OASSecurityScheme

+ type OpenAPIContext struct

+ Auth *AuthInfo

+ Ctx context.Context

+ Request *http.Request

+ Response *APIResponse

+ Spec *OpenAPISpec

+ Writer http.ResponseWriter

+ func (c *OpenAPIContext) Abort(statusCode int, code, message string)

+ func (c *OpenAPIContext) Get(key string) (any, bool)

+ func (c *OpenAPIContext) Set(key string, val any)

+ type OpenAPIInfo struct

+ Description string

+ Title string

+ Version string

+ type OpenAPIMiddlewareFunc func(ctx *OpenAPIContext, next func() error) error

+ type OpenAPIPipeline struct

+ Auth *OpenAPIStepRegistry

+ Generate *OpenAPIStepRegistry

+ Response *OpenAPIStepRegistry

+ type OpenAPIServer struct

+ Description string

+ URL string

+ type OpenAPISpec struct

+ Components OpenAPIComponents

+ Info OpenAPIInfo

+ OpenAPI string

+ Paths map[string]PathItem

+ Servers []OpenAPIServer

+ Tags []OpenAPITag

+ func GenerateSpec(reg RegistryAccessor, cfg *Config, actions []ActionConfig, ...) *OpenAPISpec

+ type OpenAPIStepRegistry struct

+ func (s *OpenAPIStepRegistry) Register(fn OpenAPIMiddlewareFunc, pos ...Position)

+ type OpenAPITag struct

+ Description string

+ Name string

+ type Operation string

+ const OpAction

+ const OpCreate

+ const OpDelete

+ const OpExport

+ const OpHead

+ const OpList

+ const OpOptions

+ const OpRead

+ const OpReadAttachment

+ const OpSearch

+ const OpUpdate

+ type PathItem struct

+ Delete *OASOperation

+ Get *OASOperation

+ Patch *OASOperation

+ Post *OASOperation

+ Put *OASOperation

+ type Pinger interface

+ Ping func(ctx context.Context) error

+ type Pipeline struct

+ Auth *StepRegistry

+ DB *StepRegistry

+ Deserialize *StepRegistry

+ OpenAPI *OpenAPIPipeline

+ Response *StepRegistry

+ Service *StepRegistry

+ Validate *StepRegistry

+ type PipelineTrace struct

+ Aborts bool

+ Bodies bool

+ Enabled bool

+ Skips bool

+ Steps bool

+ Timings bool

+ type Position int

+ const After

+ const Before

+ const Replace

+ type QueryParams struct

+ Cursor *CursorParams

+ Fields []string

+ Filters []*FilterExpr

+ Includes []string

+ Limit int

+ Page int

+ Search string

+ Sorts []SortExpr

+ func ParseQueryParams(r *http.Request, model *ModelMeta, reg RegistryAccessor) (*QueryParams, error)

+ func (q *QueryParams) HasInclude(key string) bool

+ func (q *QueryParams) Offset() int

+ type RawResult interface

+ LastInsertId func() (*int64, error)

+ Rows func() (*sql.Rows, error)

+ RowsAffected func() (*int64, error)

+ type RecursiveDirection string

+ const RecursiveAncestors

+ const RecursiveDescendants

+ type RecursiveQuery struct

+ Direction RecursiveDirection

+ MaxDepth int

+ ParentField string

+ RootID string

+ Where []*FilterExpr

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) AddForTest(meta *ModelMeta) error

+ func (r *Registry) All() []*ModelMeta

+ func (r *Registry) Get(name string) (*ModelMeta, bool)

+ type RegistryAccessor interface

+ All func() []*ModelMeta

+ Get func(name string) (*ModelMeta, bool)

+ type RelationKind int

+ const BelongsTo

+ const HasMany

+ const ManyToMany

+ type RelationMeta struct

+ CompanionField string

+ DBName string

+ FKColumn string

+ FieldName string

+ Kind RelationKind

+ OnDelete OnDeleteAction

+ RelatedModel string

+ RelationKey string

+ ThroughLocalFK string

+ ThroughModel string

+ ThroughRemoteFK string

+ ThroughTable string

+ type RequestBody struct

+ func NewRequestBody(m map[string]any) *RequestBody

+ func (b *RequestBody) Get(key string) (any, bool)

+ func (b *RequestBody) Has(key string) bool

+ func (b *RequestBody) Keys() []string

+ func (b *RequestBody) Len() int

+ func (b *RequestBody) Map() map[string]any

+ type ResponseMeta struct

+ Cursor bool

+ Dir string

+ HasMore bool

+ Limit int

+ NextCursor string

+ Page int

+ Pages int64

+ Total int64

+ func (m ResponseMeta) MarshalJSON() ([]byte, error)

+ type Row = map[string]any

+ type SQLTyper interface

+ SQLType func(driver DriverType) string

+ type SchedAction uint8

+ const SchedHardDelete

+ const SchedSetField

+ const SchedSoftDelete

+ type ScheduledSpec struct

+ Action SchedAction

+ Column string

+ Field string

+ From string

+ HasFrom bool

+ To string

+ type SearchOptions struct

+ Limit int

+ Models []string

+ PerModelLimit int

+ Query string

+ type SearchResult struct

+ ID string

+ Model string

+ Score float64

+ Snippet string

+ type Server struct

+ Pipeline *Pipeline

+ func New(cfg Config) *Server

+ func (c *Server) Action(cfg ActionConfig)

+ func (c *Server) AddService(s Service)

+ func (c *Server) DB() DBAdapter

+ func (c *Server) EnableGlobalSearch(cfg ...GlobalSearchConfig)

+ func (c *Server) Go(fn func(context.Context))

+ func (c *Server) Handler() http.Handler

+ func (c *Server) MigrateOnly(ctx context.Context) error

+ func (c *Server) MustRegister(args ...any)

+ func (c *Server) PathPrefix() string

+ func (c *Server) RealtimeDoc(cfg AsyncAPIConfig)

+ func (c *Server) Register(args ...any) error

+ func (c *Server) Registry() RegistryAccessor

+ func (c *Server) SetDB(db DBAdapter)

+ func (c *Server) SetKeyProvider(kp KeyProvider)

+ func (c *Server) SetStorage(fs FileStorage)

+ func (c *Server) Shutdown(ctx context.Context) error

+ func (c *Server) Start() error

+ func (c *Server) StartWithContext(ctx context.Context) error

+ func (s *Server) AddComputedField(modelName, name string, fn ComputedFunc) error

+ func (s *Server) MustAddComputedField(modelName, name string, fn ComputedFunc)

+ type ServerContext struct

+ AttachmentField *FieldMeta

+ Auth *AuthInfo

+ Ctx context.Context

+ DBResult any

+ DefaultLocale string

+ DefaultLocaleMode LocaleMode

+ Files map[string]*UploadedFile

+ Locale string

+ Model *ModelMeta

+ Operation Operation

+ ParsedBody *RequestBody

+ Query *QueryParams

+ RawBody []byte

+ Record any

+ Request *http.Request

+ RequestID string

+ ResourceID string

+ Response *APIResponse

+ SplitSuffix string

+ TraceID string

+ Tx Tx

+ Writer http.ResponseWriter

+ func NewBackground(ctx context.Context, adapter DBAdapter, reg RegistryAccessor) *ServerContext

+ func (c *ServerContext) Abort(statusCode int, code, message string)

+ func (c *ServerContext) Aggregate(modelName string, agg AggregateQuery) ([]Row, error)

+ func (c *ServerContext) BeginTx(ctx context.Context, opts *TxOptions) (Tx, error)

+ func (c *ServerContext) BindJSON(v any) error

+ func (c *ServerContext) DeleteField(jsonName string)

+ func (c *ServerContext) DriverType() DriverType

+ func (c *ServerContext) Field(jsonName string) (any, bool)

+ func (c *ServerContext) Get(key string) (any, bool)

+ func (c *ServerContext) GetModel(modelName string) *ModelAccessor

+ func (c *ServerContext) GoBackground(fn func(context.Context))

+ func (c *ServerContext) HasRole(role string) bool

+ func (c *ServerContext) LockForUpdate(modelName, id string) (map[string]any, error)

+ func (c *ServerContext) Logger() *slog.Logger

+ func (c *ServerContext) QueryModel(modelName string, q *QueryParams) ([]map[string]any, error)

+ func (c *ServerContext) QueryParam(name string) string

+ func (c *ServerContext) RawExec(query string, args ...any) (int64, error)

+ func (c *ServerContext) RawQuery(query string, args ...any) ([]Row, error)

+ func (c *ServerContext) RecursiveQuery(modelName string, q RecursiveQuery) ([]Row, error)

+ func (c *ServerContext) Search(opts SearchOptions) ([]SearchResult, error)

+ func (c *ServerContext) ServiceName() string

+ func (c *ServerContext) Set(key string, val any)

+ func (c *ServerContext) SetField(jsonName string, value any)

+ func (c *ServerContext) TrackStoredFile(key string, storage FileStorage)

+ func (c *ServerContext) TryBindJSON(v any) (ok bool, err error)

+ func (c *ServerContext) URLParam(name string) string

+ type Service interface

+ Start func(ctx context.Context) error

+ Stop func(ctx context.Context) error

+ type ServiceFunc func(ctx context.Context) error

+ func (ServiceFunc) Stop(context.Context) error

+ func (f ServiceFunc) Start(ctx context.Context) error

+ type SoftDeletable interface

+ SoftDeleteConfig func() SoftDeleteConfig

+ type SoftDeleteConfig struct

+ Enabled bool

+ Field string

+ FieldType SoftDeleteStyle

+ type SoftDeleteStyle int

+ const SoftDeleteBool

+ const SoftDeleteTimestamp

+ type SortDir string

+ const SortAsc

+ const SortDesc

+ type SortExpr struct

+ DBName string

+ Direction SortDir

+ IsLocale bool

+ IsNested bool

+ LocaleKey string

+ NestedField string

+ RelationFK string

+ RelationKey string

+ RelationModel string

+ RelationTable string

+ type StepRegistry struct

+ func (s *StepRegistry) Register(fn MiddlewareFunc, opts ...MiddlewareOption)

+ type Tx interface

+ Commit func() error

+ Create func(ctx context.Context, model *ModelMeta, record any) (any, error)

+ Delete func(ctx context.Context, model *ModelMeta, id string) error

+ FindByID func(ctx context.Context, model *ModelMeta, id string, q *QueryParams) (any, error)

+ FindByIDForUpdate func(ctx context.Context, model *ModelMeta, id string) (any, error)

+ FindMany func(ctx context.Context, model *ModelMeta, q *QueryParams) ([]any, int64, error)

+ Rollback func() error

+ Update func(ctx context.Context, model *ModelMeta, id string, record any, ...) (any, error)

+ func TxFromContext(ctx context.Context) Tx

+ type TxOptions = sql.TxOptions

+ type UploadedFile struct

+ ContentType string

+ Filename string

+ Reader io.ReadCloser

+ Size int64

+ type WithDeletedAt struct

+ DeletedAt *time.Time

+ func (WithDeletedAt) SoftDeleteConfig() SoftDeleteConfig

+ type WithIsDeleted struct

+ IsDeleted bool

+ func (WithIsDeleted) SoftDeleteConfig() SoftDeleteConfig

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