schemahcl

Documentation

Index

• Variables
• func New(opts ...Option) *state
• type Config
• type Option
  • func WithScopedEnums(path string, enums ...string) Option
  • func WithTypes(typeSpecs []*schemaspec.TypeSpec) Option

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 New

func New(opts ...Option) *state

New returns a state configured with options.

Types

type Config

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

Config configures an unmarshaling.

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.