catalog

Jul 29, 2026

Changes in this version

+ var ErrCatalogNotManaged = errors.New("catalog provider does not manage catalogs")

+ var ErrNoLogicalModel = errors.New("catalog provider has no logical model")

+ var ErrSchemaInvalid = errors.New("catalog schema is invalid")

+ type CatalogChecker interface

+ ExistsCatalog func(name string) bool

+ type DataSourceInfo struct

+ AsModule bool

+ Description string

+ Engine string

+ IsExtension bool

+ LongDescription string

+ Modules []string

+ Name string

+ ReadOnly bool

+ type FunctionEntry struct

+ DataSource string

+ Field *ast.FieldDefinition

+ IsTable bool

+ Kind sdl.ModuleObjectType

+ LongDescription string

+ Module string

+ type LogicalModel interface

+ DataObject func(ctx context.Context, name string) *sdl.Object

+ DataObjects func(ctx context.Context, module string) iter.Seq[*sdl.Object]

+ DataSource func(ctx context.Context, name string) *DataSourceInfo

+ DataSources func(ctx context.Context) iter.Seq[*DataSourceInfo]

+ Function func(ctx context.Context, module, name string) *FunctionEntry

+ Functions func(ctx context.Context, module string) iter.Seq[*FunctionEntry]

+ Module func(ctx context.Context, name string) *ModuleInfo

+ Modules func(ctx context.Context, parent string) iter.Seq[*ModuleInfo]

+ Relations func(ctx context.Context, object string) iter.Seq[*RelationInfo]

+ SourceTypes func(ctx context.Context) iter.Seq2[string, *ast.Definition]

+ SystemTypes func(ctx context.Context) iter.Seq2[string, *ast.Definition]

+ Type func(ctx context.Context, name string) *ast.Definition

+ func LogicalModelFromProvider(p Provider) (LogicalModel, error)

+ type ModuleInfo struct

+ DataSources []string

+ Description string

+ LongDescription string

+ Name string

+ RootTypes map[sdl.ModuleObjectType]string

+ type RelationDirection string

+ const RelationBack

+ const RelationForward

+ type RelationInfo struct

+ DataObject string

+ DataSource string

+ Description string

+ DestinationKeys []string

+ Direction RelationDirection

+ FieldName string

+ Kind RelationKind

+ Name string

+ SourceKeys []string

+ Through string

+ type RelationKind string

+ const RelationFK

+ const RelationJoin

+ const RelationM2M

+ type ReplacingCatalogManager interface

+ ReplacesCatalogOnAdd func() bool

type Service

+ func (s *Service) ReplacesCatalogOnAdd() bool

Apr 2, 2026

Changes in this version

type CatalogManager

+ IsSuspended func(name string) bool

+ ReactivateCatalog func(ctx context.Context, name string, catalog Catalog) error

+ SuspendCatalog func(ctx context.Context, name string) error

type Manager

+ IsSuspended func(name string) bool

+ ReactivateCatalog func(ctx context.Context, name string, catalog Catalog) error

+ SuspendCatalog func(ctx context.Context, name string) error

type Service

+ func (s *Service) IsSuspended(name string) bool

+ func (s *Service) ReactivateCatalog(ctx context.Context, name string, catalog Catalog) error

+ func (s *Service) SuspendCatalog(ctx context.Context, name string) error

Mar 7, 2026

Changes in this version

+ var ErrCatalogAlreadyExists = errors.New("catalog already exists")

+ var ErrCatalogNotFound = errors.New("catalog not found")

+ func QueryRequestInfo(ss ast.SelectionSet) ([]sdl.QueryRequest, sdl.QueryType)

+ type Catalog = sources.Catalog

+ type CatalogManager interface

+ AddCatalog func(ctx context.Context, name string, catalog Catalog) error

+ ExistsCatalog func(name string) bool

+ ReloadCatalog func(ctx context.Context, name string) error

+ RemoveCatalog func(ctx context.Context, name string) error

+ type ExtensionCatalog = sources.ExtensionCatalog

+ type IncrementalCatalog = sources.IncrementalCatalog

+ type Manager interface

+ AddCatalog func(ctx context.Context, name string, catalog Catalog) error

+ Engine func(name string) (engines.Engine, error)

+ ExistsCatalog func(name string) bool

+ RegisterEngine func(name string, engine engines.Engine)

+ ReloadCatalog func(ctx context.Context, name string) error

+ RemoveCatalog func(ctx context.Context, name string) error

+ type Operation struct

+ Definition *ast.OperationDefinition

+ Fragments ast.FragmentDefinitionList

+ Queries []sdl.QueryRequest

+ QueryType sdl.QueryType

+ Variables map[string]any

+ func ParseQuery(ctx context.Context, p Provider, query string, vars map[string]any, ...) (*Operation, error)

+ type ParseOption func(*parseConfig)

+ func WithOperationName(name string) ParseOption

+ func WithValidator(v *validator.Validator) ParseOption

+ func WithVariableTransformer(t VariableTransformer) ParseOption

+ type Provider base.Provider

+ type Querier interface

+ Query func(ctx context.Context, query string, vars map[string]any) (*types.Response, error)

+ type ReloadableCatalog = sources.ReloadableCatalog

+ type Service struct

+ func NewService(p Provider, opts ...ServiceOption) *Service

+ func (s *Service) AddCatalog(ctx context.Context, name string, catalog Catalog) error

+ func (s *Service) Definitions(ctx context.Context) iter.Seq[*ast.Definition]

+ func (s *Service) Description(ctx context.Context) string

+ func (s *Service) DirectiveDefinitions(ctx context.Context) iter.Seq2[string, *ast.DirectiveDefinition]

+ func (s *Service) DirectiveForName(ctx context.Context, name string) *ast.DirectiveDefinition

+ func (s *Service) Engine(name string) (engines.Engine, error)

+ func (s *Service) ExistsCatalog(name string) bool

+ func (s *Service) ForName(ctx context.Context, name string) *ast.Definition

+ func (s *Service) Implements(ctx context.Context, name string) iter.Seq[*ast.Definition]

+ func (s *Service) MutationType(ctx context.Context) *ast.Definition

+ func (s *Service) ParseQuery(ctx context.Context, query string, vars map[string]any, operationName string) (*Operation, error)

+ func (s *Service) PossibleTypes(ctx context.Context, name string) iter.Seq[*ast.Definition]

+ func (s *Service) Provider() Provider

+ func (s *Service) QueryType(ctx context.Context) *ast.Definition

+ func (s *Service) RegisterEngine(name string, engine engines.Engine)

+ func (s *Service) ReloadCatalog(ctx context.Context, name string) error

+ func (s *Service) RemoveCatalog(ctx context.Context, name string) error

+ func (s *Service) SchemaProvider() Provider

+ func (s *Service) SetProvider(p Provider)

+ func (s *Service) SetVariableTransformer(t VariableTransformer)

+ func (s *Service) SubscriptionType(ctx context.Context) *ast.Definition

+ func (s *Service) Types(ctx context.Context) iter.Seq2[string, *ast.Definition]

+ func (s *Service) ValidateQuery(ctx context.Context, query string) (*ast.QueryDocument, error)

+ type ServiceOption func(*Service)

+ func WithServiceValidator(v *validator.Validator) ServiceOption

+ func WithServiceVarTransformer(t VariableTransformer) ServiceOption

+ type VariableTransformer interface

+ TransformVariables func(ctx context.Context, vars map[string]any) (map[string]any, error)

+ func NewJQVariableTransformer(querier Querier) VariableTransformer