schema

Documentation

Overview

Content managed by Project Forge, see [projectforge.md] for details.

Content managed by Project Forge, see [projectforge.md] for details.

Content managed by Project Forge, see [projectforge.md] for details.

Content managed by Project Forge, see [projectforge.md] for details.

Content managed by Project Forge, see [projectforge.md] for details.

Content managed by Project Forge, see [projectforge.md] for details.

Index

• Constants
• Variables
• func OriginKeys() []string
• func OriginTitles() []string
• type Metadata
• type Origin
  • func OriginFromString(s string) Origin
  • func (t *Origin) MarshalJSON() ([]byte, error)
  • func (t *Origin) String() string
  • func (t *Origin) UnmarshalJSON(data []byte) error
• type Override
  • func NewOverride(typ string, path util.Pkg, prop string, val any) *Override
  • func (o *Override) ApplyTo(s *Schema) error
  • func (o Override) String() string
• type Overrides
  • func (o Overrides) Purge(path util.Pkg) Overrides
  • func (o Overrides) Sort()
• type Scalar
• type Scalars
  • func (s Scalars) Get(pkg util.Pkg, key string) *Scalar
• type Schema
  • func (s *Schema) AddModel(m *model.Model) error
  • func (s *Schema) AddPath(path string) bool
  • func (s *Schema) AddScalar(sc *Scalar) error
  • func (s *Schema) CreateReferences() error
  • func (s *Schema) Hack(logger util.Logger) (string, error)
  • func (s *Schema) ModelsByPackage() *model.Package
  • func (s *Schema) Validate(n string) *ValidationResult
  • func (s *Schema) ValidateModel(sch string, m *model.Model) *ValidationResult
• type Schemata
  • func (s Schemata) Get(key string) *Schema
  • func (s Schemata) GetWithError(key string) (*Schema, error)
• type ValidationMessage
• type ValidationResult

Constants

const (
	KeyTitle  = "title"
	KeyPlural = "plural"
)

const (
	LevelInfo = iota
	LevelWarn
	LevelError
)

Variables

var (
	OriginMySQL      = Origin{Key: "mysql", Title: "MySQL", Icon: "database", Description: "MySQL database schema"}
	OriginPostgres   = Origin{Key: "postgres", Title: "PostgreSQL", Icon: "database", Description: "PostgreSQL database schema"}
	OriginSQLite     = Origin{Key: "sqlite", Title: "SQLite", Icon: "database", Description: "SQLite database schema"}
	OriginGraphQL    = Origin{Key: "graphql", Title: "GraphQL", Icon: "star", Description: "GraphQL schema and queries"}
	OriginProtobuf   = Origin{Key: "protobuf", Title: "Protobuf", Icon: "star", Description: "File describing proto3 definitions"}
	OriginJSONSchema = Origin{Key: "jsonschema", Title: "JSON Schema", Icon: "star", Description: "JSON Schema definition files"}
	OriginMock       = Origin{Key: "mock", Title: "Mock", Icon: "star", Description: "Simple type that returns mock data"}
	OriginUnknown    = Origin{Key: "unknown", Title: "Unknown", Icon: "star", Description: "Not quite sure what this is"}
)

var AllOrigins = []Origin{OriginMySQL, OriginPostgres, OriginSQLite, OriginGraphQL, OriginProtobuf, OriginJSONSchema, OriginMock}

Functions

func OriginKeys

func OriginKeys() []string

func OriginTitles

func OriginTitles() []string

Types

type Metadata

type Metadata struct {
	Description string   `json:"description,omitempty"`
	Comments    []string `json:"comments,omitempty"`
	Origin      *Origin  `json:"origin,omitempty"`
	Source      string   `json:"source,omitempty"`
	Line        int      `json:"line,omitempty"`
	Column      int      `json:"column,omitempty"`
}

type Origin

type Origin struct {
	Key         string `json:"key"`
	Title       string `json:"title,omitempty"`
	Icon        string `json:"icon,omitempty"`
	Description string `json:"description,omitempty"`
}

func OriginFromString

func OriginFromString(s string) Origin

func (*Origin) MarshalJSON

func (t *Origin) MarshalJSON() ([]byte, error)

func (*Origin) String

func (t *Origin) String() string

func (*Origin) UnmarshalJSON

func (t *Origin) UnmarshalJSON(data []byte) error

type Override

type Override struct {
	Type string   `json:"type,omitempty"`
	Path util.Pkg `json:"path,omitempty"`
	Prop string   `json:"prop,omitempty"`
	Val  any      `json:"val,omitempty"`
}

func NewOverride

func NewOverride(typ string, path util.Pkg, prop string, val any) *Override

func (*Override) ApplyTo

func (o *Override) ApplyTo(s *Schema) error

func (Override) String

func (o Override) String() string

type Overrides

type Overrides []*Override

func (Overrides) Purge

func (o Overrides) Purge(path util.Pkg) Overrides

func (Overrides) Sort

func (o Overrides) Sort()

type Scalar

type Scalar struct {
	Pkg         util.Pkg  `json:"pkg,omitempty"`
	Key         string    `json:"key"`
	Type        string    `json:"type"`
	Description string    `json:"description,omitempty"`
	Metadata    *Metadata `json:"metadata,omitempty"`
}

type Scalars

type Scalars []*Scalar

func (Scalars) Get

func (s Scalars) Get(pkg util.Pkg, key string) *Scalar

type Schema

type Schema struct {
	Paths    []string     `json:"paths,omitempty"`
	Scalars  Scalars      `json:"scalars,omitempty"`
	Models   model.Models `json:"models,omitempty"`
	Metadata *Metadata    `json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*Schema) AddModel

func (s *Schema) AddModel(m *model.Model) error

func (*Schema) AddPath

func (s *Schema) AddPath(path string) bool

func (*Schema) AddScalar

func (s *Schema) AddScalar(sc *Scalar) error

func (*Schema) CreateReferences

func (s *Schema) CreateReferences() error

func (*Schema) Hack

func (s *Schema) Hack(logger util.Logger) (string, error)

func (*Schema) ModelsByPackage

func (s *Schema) ModelsByPackage() *model.Package

func (*Schema) Validate

func (s *Schema) Validate(n string) *ValidationResult

func (*Schema) ValidateModel

func (s *Schema) ValidateModel(sch string, m *model.Model) *ValidationResult

type Schemata

type Schemata map[string]*Schema

func (Schemata) Get

func (s Schemata) Get(key string) *Schema

func (Schemata) GetWithError

func (s Schemata) GetWithError(key string) (*Schema, error)

type ValidationMessage

type ValidationMessage struct {
	Category string `json:"category,omitempty"`
	ModelKey string `json:"modelKey,omitempty"`
	Message  string `json:"message,omitempty"`
	Level    int    `json:"level,omitempty"`
}

type ValidationResult

type ValidationResult struct {
	Schema   string              `json:"schema,omitempty"`
	Messages []ValidationMessage `json:"messages,omitempty"`
	Duration int64               `json:"duration,omitempty"`
}