melange

Jan 8, 2026

Changes in this version

type Option

+ func WithValidator(v Validator) Option

+ type Validator interface

+ ValidateCheckRequest func(subject Object, relation Relation, object Object) error

+ ValidateContextualTuple func(tuple ContextualTuple) error

+ ValidateListUsersRequest func(relation Relation, object Object, subjectType ObjectType) error

+ ValidateUsersetSubject func(subject Object) error

Jan 5, 2026

Changes in this version

+ const ErrorCodeAuthorizationModelNotFound

+ const ErrorCodeResolutionTooComplex

+ const ErrorCodeValidation

+ var ErrContextualTuplesUnsupported = errors.New("melange: contextual tuples require *sql.DB, *sql.Tx, or *sql.Conn")

+ var ErrCyclicSchema = errors.New("melange: cyclic schema")

+ var ErrInvalidContextualTuple = errors.New("melange: contextual tuple invalid")

+ func GetValidationErrorCode(err error) int

+ func IsCyclicSchemaErr(err error) bool

+ func IsValidationError(err error) bool

type Checker

+ func (c *Checker) CheckWithContextualTuples(ctx context.Context, subject SubjectLike, relation RelationLike, ...) (bool, error)

+ func (c *Checker) ListObjectsWithContextualTuples(ctx context.Context, subject SubjectLike, relation RelationLike, ...) ([]string, error)

+ func (c *Checker) ListSubjectsWithContextualTuples(ctx context.Context, object ObjectLike, relation RelationLike, ...) ([]string, error)

+ type ContextualTuple struct

+ Object Object

+ Relation Relation

+ Subject Object

type Option

+ func WithRequestValidation() Option

+ func WithUsersetValidation() Option

+ type ValidationError struct

+ Code int

+ Message string

+ func (e *ValidationError) Error() string

+ func (e *ValidationError) ErrorCode() int

Jan 3, 2026

Changes in this version

+ var ErrEmptyModel = errors.New("melange: authorization model empty")

+ var ErrInvalidSchema = errors.New("melange: invalid schema")

+ var ErrMissingFunction = errors.New("melange: authorization function missing")

+ var ErrMissingModel = errors.New("melange: melange_model table missing")

+ var ErrNoTuplesTable = errors.New("melange: melange_tuples view/table not found")

+ func GenerateGo(w io.Writer, types []TypeDefinition, cfg *GenerateConfig) error

+ func IsEmptyModelErr(err error) bool

+ func IsInvalidSchemaErr(err error) bool

+ func IsMissingFunctionErr(err error) bool

+ func IsMissingModelErr(err error) bool

+ func IsNoTuplesTableErr(err error) bool

+ func RelationSubjects(types []TypeDefinition, objectType string, relation string) []string

+ func SubjectTypes(types []TypeDefinition) []string

+ func WithDecisionContext(ctx context.Context, decision Decision) context.Context

+ type AuthzModel struct

+ ExcludedRelation *string

+ ID int64

+ ImpliedBy *string

+ ObjectType string

+ ParentRelation *string

+ Relation string

+ SubjectType *string

+ func ToAuthzModels(types []TypeDefinition) []AuthzModel

+ type Cache interface

+ Get func(subject Object, relation Relation, object Object) (allowed bool, err error, ok bool)

+ Set func(subject Object, relation Relation, object Object, allowed bool, err error)

+ type CacheImpl struct

+ func NewCache(opts ...CacheOption) *CacheImpl

+ func (c *CacheImpl) Clear()

+ func (c *CacheImpl) Get(subject Object, relation Relation, object Object) (bool, error, bool)

+ func (c *CacheImpl) Set(subject Object, relation Relation, object Object, allowed bool, err error)

+ func (c *CacheImpl) Size() int

+ type CacheOption func(*CacheImpl)

+ func WithTTL(ttl time.Duration) CacheOption

+ type Checker struct

+ func NewChecker(q Querier, opts ...Option) *Checker

+ func (c *Checker) Check(ctx context.Context, subject SubjectLike, relation RelationLike, ...) (bool, error)

+ func (c *Checker) ListObjects(ctx context.Context, subject SubjectLike, relation RelationLike, ...) ([]string, error)

+ func (c *Checker) ListSubjects(ctx context.Context, object ObjectLike, relation RelationLike, ...) ([]string, error)

+ func (c *Checker) Must(ctx context.Context, subject SubjectLike, relation RelationLike, ...)

+ type Decision int

+ const DecisionAllow

+ const DecisionDeny

+ const DecisionUnset

+ func GetDecisionContext(ctx context.Context) Decision

+ type Execer interface

+ ExecContext func(ctx context.Context, query string, args ...any) (sql.Result, error)

+ type GenerateConfig struct

+ IDType string

+ Package string

+ RelationPrefixFilter string

+ func DefaultGenerateConfig() *GenerateConfig

+ type Migrator struct

+ func NewMigrator(db Execer, schemasDir string) *Migrator

+ func (m *Migrator) ApplyDDL(ctx context.Context) error

+ func (m *Migrator) GetStatus(ctx context.Context) (*Status, error)

+ func (m *Migrator) HasSchema() bool

+ func (m *Migrator) MigrateWithTypes(ctx context.Context, types []TypeDefinition) error

+ func (m *Migrator) SchemaPath() string

+ type Object struct

+ ID string

+ Type ObjectType

+ func (o Object) FGAObject() Object

+ func (o Object) FGASubject() Object

+ func (o Object) String() string

+ type ObjectLike interface

+ FGAObject func() Object

+ type ObjectType string

+ func (ot ObjectType) String() string

+ type Option func(*Checker)

+ func WithCache(c Cache) Option

+ func WithContextDecision() Option

+ func WithDecision(d Decision) Option

+ type Querier interface

+ QueryContext func(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ QueryRowContext func(ctx context.Context, query string, args ...any) *sql.Row

+ type Relation string

+ func (r Relation) FGARelation() Relation

+ func (r Relation) String() string

+ type RelationDefinition struct

+ ExcludedRelation string

+ ImpliedBy []string

+ Name string

+ ParentRelation string

+ ParentType string

+ SubjectTypes []string

+ type RelationLike interface

+ FGARelation func() Relation

+ type Status struct

+ ModelCount int64

+ SchemaExists bool

+ type SubjectLike interface

+ FGASubject func() Object

+ type TypeDefinition struct

+ Name string

+ Relations []RelationDefinition