schemahcl

Documentation

Index

• Variables
• func AliasTypeSpec(name, dbType string, opts ...TypeSpecOption) *schemaspec.TypeSpec
• func SizeTypeAttr(required bool) *schemaspec.TypeAttr
• func TypeSpec(name string, opts ...TypeSpecOption) *schemaspec.TypeSpec
• type Config
• type EvalFunc
  • func (f EvalFunc) Eval(data []byte, v interface{}, input map[string]string) error
• type Evaluator
• type Option
  • func WithScopedEnums(path string, enums ...string) Option
  • func WithTypes(typeSpecs []*schemaspec.TypeSpec) Option
• type State
  • func New(opts ...Option) *State
  • func (s *State) Eval(data []byte, v interface{}, input map[string]string) error
  • func (s *State) MarshalSpec(v interface{}) ([]byte, error)
  • func (s *State) UnmarshalSpec(data []byte, v interface{}) error
• type TypeRegistry
  • func NewRegistry(opts ...TypeRegistryOption) *TypeRegistry
  • func (r *TypeRegistry) Convert(typ schema.Type) (*schemaspec.Type, error)
  • func (r *TypeRegistry) PrintType(typ *schemaspec.Type) (string, error)
  • func (r *TypeRegistry) Register(specs ...*schemaspec.TypeSpec) error
  • func (r *TypeRegistry) Specs() []*schemaspec.TypeSpec
  • func (r *TypeRegistry) Type(typ *schemaspec.Type, extra []*schemaspec.Attr) (schema.Type, error)
• type TypeRegistryOption
  • func WithFormatter(f func(schema.Type) (string, error)) TypeRegistryOption
  • func WithParser(parser func(string) (schema.Type, error)) TypeRegistryOption
  • func WithSpecFunc(spec func(schema.Type) (*schemaspec.Type, error)) TypeRegistryOption
  • func WithSpecs(specs ...*schemaspec.TypeSpec) TypeRegistryOption
• type TypeSpecOption
  • func WithAttributes(attrs ...*schemaspec.TypeAttr) TypeSpecOption
  • func WithTypeFormatter(f func(*schemaspec.Type) (string, error)) TypeSpecOption

Variables

var (
	// Marshal returns the Atlas HCL encoding of v.
	Marshal = schemaspec.MarshalerFunc(New().MarshalSpec)
)

var (
	// Unmarshal parses the Atlas HCL-encoded data and stores the result in the target.
	Unmarshal = schemaspec.UnmarshalerFunc(New().UnmarshalSpec)
)

Functions

func AliasTypeSpec

func AliasTypeSpec(name, dbType string, opts ...TypeSpecOption) *schemaspec.TypeSpec

AliasTypeSpec returns a TypeSpec with the provided name.

func SizeTypeAttr

func SizeTypeAttr(required bool) *schemaspec.TypeAttr

SizeTypeAttr returns a TypeAttr for a size attribute.

func TypeSpec

func TypeSpec(name string, opts ...TypeSpecOption) *schemaspec.TypeSpec

TypeSpec returns a TypeSpec with the provided name.

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config configures an unmarshaling.

type EvalFunc

type EvalFunc func([]byte, interface{}, map[string]string) error

EvalFunc is an adapter that allows the use of an ordinary function as an Evaluator.

func (EvalFunc) Eval

func (f EvalFunc) Eval(data []byte, v interface{}, input map[string]string) error

Eval implements the Evaluator interface.

type Evaluator

type Evaluator interface {
	Eval([]byte, interface{}, map[string]string) error
}

Evaluator evaluates the Atlas DDL document with the given input and stores it in the provided object.

type Option

type Option func(*Config)

Option configures a Config.

func WithScopedEnums

func WithScopedEnums(path string, enums ...string) Option

WithScopedEnums configured a list of allowed ENUMs to be used in the given context, block or attribute. For example, the following option allows setting HASH or BTREE to the "using" attribute in "index" block.

WithScopedEnums("table.index.type", "HASH", "BTREE")

table "t" {
	...
	index "i" {
		type = HASH     // Allowed.
		type = INVALID  // Not Allowed.
	}
}

func WithTypes

func WithTypes(typeSpecs []*schemaspec.TypeSpec) Option

WithTypes configures the list of given types as identifiers in the unmarshaling context.

type State

type State struct {
	// contains filtered or unexported fields
}

State implements schemaspec.Unmarshaler and schemaspec.Marshaler for Atlas HCL syntax and stores a configuration for these operations.

func New

func New(opts ...Option) *State

New returns a State configured with options.

func (*State) Eval

func (s *State) Eval(data []byte, v interface{}, input map[string]string) error

Eval implements the Evaluator interface.

func (*State) MarshalSpec

func (s *State) MarshalSpec(v interface{}) ([]byte, error)

MarshalSpec implements schemaspec.Marshaler for Atlas HCL documents.

func (*State) UnmarshalSpec

func (s *State) UnmarshalSpec(data []byte, v interface{}) error

UnmarshalSpec implements schemaspec.Unmarshaler.

type TypeRegistry

type TypeRegistry struct {
	// contains filtered or unexported fields
}

TypeRegistry is a collection of *schemaspec.TypeSpec.

func NewRegistry

func NewRegistry(opts ...TypeRegistryOption) *TypeRegistry

NewRegistry creates a new *TypeRegistry, registers the provided types and panics if an error occurs.

func (*TypeRegistry) Convert

func (r *TypeRegistry) Convert(typ schema.Type) (*schemaspec.Type, error)

Convert converts the schema.Type to a *schemaspec.Type.

func (*TypeRegistry) PrintType

func (r *TypeRegistry) PrintType(typ *schemaspec.Type) (string, error)

PrintType returns the string representation of a column type which can be parsed by the driver into a schema.Type.

func (*TypeRegistry) Register

func (r *TypeRegistry) Register(specs ...*schemaspec.TypeSpec) error

Register adds one or more TypeSpec to the registry.

func (*TypeRegistry) Specs

func (r *TypeRegistry) Specs() []*schemaspec.TypeSpec

Specs returns the TypeSpecs in the registry.

func (*TypeRegistry) Type

func (r *TypeRegistry) Type(typ *schemaspec.Type, extra []*schemaspec.Attr) (schema.Type, error)

Type converts a *schemaspec.Type into a schema.Type.

type TypeRegistryOption

type TypeRegistryOption func(*TypeRegistry) error

TypeRegistryOption configures a TypeRegistry.

func WithFormatter

func WithFormatter(f func(schema.Type) (string, error)) TypeRegistryOption

WithFormatter configures the registry to use a formatting function for printing schema.Type as string.

func WithParser

func WithParser(parser func(string) (schema.Type, error)) TypeRegistryOption

WithParser configures the registry to use a parsing function for converting a string to a schema.Type.

func WithSpecFunc

func WithSpecFunc(spec func(schema.Type) (*schemaspec.Type, error)) TypeRegistryOption

WithSpecFunc configures the registry to use the given function for converting a schema.Type to schemaspec.Type

func WithSpecs

func WithSpecs(specs ...*schemaspec.TypeSpec) TypeRegistryOption

WithSpecs configures the registry to register the given list of type specs.

type TypeSpecOption

type TypeSpecOption func(*schemaspec.TypeSpec)

TypeSpecOption configures a schemaspec.TypeSpec.

func WithAttributes

func WithAttributes(attrs ...*schemaspec.TypeAttr) TypeSpecOption

WithAttributes returns an attributes TypeSpecOption.

func WithTypeFormatter

func WithTypeFormatter(f func(*schemaspec.Type) (string, error)) TypeSpecOption

WithTypeFormatter allows overriding the Format function for the Type.