specutil

Documentation

Index

• Variables
• func Check(spec *sqlspec.Check) (*schema.Check, error)
• func Column(spec *sqlspec.Column, conv ConvertTypeFunc) (*schema.Column, error)
• func ColumnByRef(t *schema.Table, ref *schemahcl.Ref) (*schema.Column, error)
• func ColumnRef(cName string) *schemahcl.Ref
• func ConvertGenExpr(r *schemahcl.Resource, c *schema.Column, t func(string) string) error
• func ExprValue(expr schema.Expr) (cty.Value, error)
• func FromCheck(s *schema.Check) *sqlspec.Check
• func FromColumn(col *schema.Column, columnTypeSpec ColumnTypeSpecFunc) (*sqlspec.Column, error)
• func FromForeignKey(s *schema.ForeignKey) (*sqlspec.ForeignKey, error)
• func FromGenExpr(x schema.GeneratedExpr, t func(string) string) *schemahcl.Resource
• func FromIndex(idx *schema.Index, ...) (*sqlspec.Index, error)
• func FromPrimaryKey(s *schema.Index) (*sqlspec.PrimaryKey, error)
• func FromSchema(s *schema.Schema, fn TableSpecFunc) (*sqlspec.Schema, []*sqlspec.Table, error)
• func FromTable(t *schema.Table, colFn ColumnSpecFunc, pkFn PrimaryKeySpecFunc, ...) (*sqlspec.Table, error)
• func FromVar(s string) string
• func HCLBytesFunc(ev schemahcl.Evaluator) func(b []byte, v any, inp map[string]cty.Value) error
• func Index(spec *sqlspec.Index, parent *schema.Table, ...) (*schema.Index, error)
• func Marshal(v any, marshaler schemahcl.Marshaler, ...) ([]byte, error)
• func PrimaryKey(spec *sqlspec.PrimaryKey, parent *schema.Table) (*schema.Index, error)
• func QualifyDuplicates(tableSpecs []*sqlspec.Table) error
• func QualifyReferences(tableSpecs []*sqlspec.Table, realm *schema.Realm) error
• func Scan(r *schema.Realm, schemas []*sqlspec.Schema, tables []*sqlspec.Table, ...) error
• func SchemaName(ref *schemahcl.Ref) (string, error)
• func SchemaRef(name string) *schemahcl.Ref
• func Table(spec *sqlspec.Table, parent *schema.Schema, convertColumn ConvertColumnFunc, ...) (*schema.Table, error)
• func Var(s string) string
• func VarAttr(k, v string) *schemahcl.Attr
• type Attrer
• type CheckSpecFunc
• type ColumnSpecFunc
• type ColumnTypeSpecFunc
• type ConvertCheckFunc
• type ConvertColumnFunc
• type ConvertIndexFunc
• type ConvertPrimaryKeyFunc
• type ConvertTableFunc
• type ConvertTypeFunc
• type ForeignKeySpecFunc
• type IndexSpecFunc
• type PrimaryKeySpecFunc
• type TableSpecFunc

Variables

var ReferenceVars = []string{
	Var(string(schema.NoAction)),
	Var(string(schema.Restrict)),
	Var(string(schema.Cascade)),
	Var(string(schema.SetNull)),
	Var(string(schema.SetDefault)),
}

ReferenceVars holds the HCL variables for foreign keys' referential-actions.

Functions

func Check

func Check(spec *sqlspec.Check) (*schema.Check, error)

Check converts a sqlspec.Check to a schema.Check.

func Column

func Column(spec *sqlspec.Column, conv ConvertTypeFunc) (*schema.Column, error)

Column converts a sqlspec.Column into a schema.Column.

func ColumnByRef

func ColumnByRef(t *schema.Table, ref *schemahcl.Ref) (*schema.Column, error)

ColumnByRef returns a column from the table by its reference.

func ColumnRef

func ColumnRef(cName string) *schemahcl.Ref

ColumnRef returns the reference of a column by its name.

func ConvertGenExpr

func ConvertGenExpr(r *schemahcl.Resource, c *schema.Column, t func(string) string) error

ConvertGenExpr converts the "as" attribute or the block under the given resource.

func ExprValue

func ExprValue(expr schema.Expr) (cty.Value, error)

ExprValue converts a schema.Expr to a cty.Value.

func FromCheck

func FromCheck(s *schema.Check) *sqlspec.Check

FromCheck converts schema.Check to sqlspec.Check.

func FromColumn

func FromColumn(col *schema.Column, columnTypeSpec ColumnTypeSpecFunc) (*sqlspec.Column, error)

FromColumn converts a *schema.Column into a *sqlspec.Column using the ColumnTypeSpecFunc.

func FromForeignKey

func FromForeignKey(s *schema.ForeignKey) (*sqlspec.ForeignKey, error)

FromForeignKey converts schema.ForeignKey to sqlspec.ForeignKey.

func FromGenExpr

func FromGenExpr(x schema.GeneratedExpr, t func(string) string) *schemahcl.Resource

FromGenExpr returns the spec for a generated expression.

func FromIndex

func FromIndex(idx *schema.Index, partFns ...func(*schema.Index, *schema.IndexPart, *sqlspec.IndexPart) error) (*sqlspec.Index, error)

FromIndex converts schema.Index to sqlspec.Index.

func FromPrimaryKey

func FromPrimaryKey(s *schema.Index) (*sqlspec.PrimaryKey, error)

FromPrimaryKey converts schema.Index to a sqlspec.PrimaryKey.

func FromSchema

func FromSchema(s *schema.Schema, fn TableSpecFunc) (*sqlspec.Schema, []*sqlspec.Table, error)

FromSchema converts a schema.Schema into sqlspec.Schema and []sqlspec.Table.

func FromTable

func FromTable(t *schema.Table, colFn ColumnSpecFunc, pkFn PrimaryKeySpecFunc, idxFn IndexSpecFunc,
	fkFn ForeignKeySpecFunc, ckFn CheckSpecFunc) (*sqlspec.Table, error)

FromTable converts a schema.Table to a sqlspec.Table.

func FromVar

func FromVar(s string) string

FromVar is the inverse function of Var.

func HCLBytesFunc

func HCLBytesFunc(ev schemahcl.Evaluator) func(b []byte, v any, inp map[string]cty.Value) error

HCLBytesFunc returns a helper that evaluates an HCL document from a byte slice instead of from an hclparse.Parser instance.

func Index

func Index(spec *sqlspec.Index, parent *schema.Table, partFns ...func(*sqlspec.IndexPart, *schema.IndexPart) error) (*schema.Index, error)

Index converts a sqlspec.Index to a schema.Index. The optional arguments allow passing functions for mutating the created index-part (e.g. add attributes).

func Marshal

func Marshal(v any, marshaler schemahcl.Marshaler, schemaSpec func(schem *schema.Schema) (*sqlspec.Schema, []*sqlspec.Table, error)) ([]byte, error)

Marshal marshals v into an Atlas DDL document using a schemahcl.Marshaler. Marshal uses the given schemaSpec function to convert a *schema.Schema into *sqlspec.Schema and []*sqlspec.Table.

func PrimaryKey

func PrimaryKey(spec *sqlspec.PrimaryKey, parent *schema.Table) (*schema.Index, error)

PrimaryKey converts a sqlspec.PrimaryKey to a schema.Index.

func QualifyDuplicates

func QualifyDuplicates(tableSpecs []*sqlspec.Table) error

QualifyDuplicates sets the Qualified field equal to the schema name in any tables with duplicate names in the provided table specs.

func QualifyReferences

func QualifyReferences(tableSpecs []*sqlspec.Table, realm *schema.Realm) error

QualifyReferences qualifies any reference with qualifier.

func Scan

func Scan(r *schema.Realm, schemas []*sqlspec.Schema, tables []*sqlspec.Table, convertTable ConvertTableFunc) error

Scan populates the Realm from the schemas and table specs.

func SchemaName

func SchemaName(ref *schemahcl.Ref) (string, error)

SchemaName returns the name from a ref to a schema.

func SchemaRef

func SchemaRef(name string) *schemahcl.Ref

SchemaRef returns the schemahcl.Ref to the schema with the given name.

func Table

func Table(spec *sqlspec.Table, parent *schema.Schema, convertColumn ConvertColumnFunc,
	convertPK ConvertPrimaryKeyFunc, convertIndex ConvertIndexFunc, convertCheck ConvertCheckFunc) (*schema.Table, error)

Table converts a sqlspec.Table to a schema.Table. Table conversion is done without converting ForeignKeySpecs into ForeignKeys, as the target tables do not necessarily exist in the schema at this point. Instead, the linking is done by the Schema function.

func Var

func Var(s string) string

Var formats a string as variable to make it HCL compatible. The result is simple, replace each space with underscore.

func VarAttr

func VarAttr(k, v string) *schemahcl.Attr

VarAttr is a helper method for constructing *schemahcl.Attr instances that contain a variable reference.

Types

type Attrer

type Attrer interface {
	Attr(string) (*schemahcl.Attr, bool)
}

Attrer is the interface that wraps the Attr method.

type CheckSpecFunc

type CheckSpecFunc func(*schema.Check) *sqlspec.Check

List of convert function types.

type ColumnSpecFunc

type ColumnSpecFunc func(*schema.Column, *schema.Table) (*sqlspec.Column, error)

List of convert function types.

type ColumnTypeSpecFunc

type ColumnTypeSpecFunc func(schema.Type) (*sqlspec.Column, error)

List of convert function types.

type ConvertCheckFunc

type ConvertCheckFunc func(*sqlspec.Check) (*schema.Check, error)

List of convert function types.

type ConvertColumnFunc

type ConvertColumnFunc func(*sqlspec.Column, *schema.Table) (*schema.Column, error)

List of convert function types.

type ConvertIndexFunc

type ConvertIndexFunc func(*sqlspec.Index, *schema.Table) (*schema.Index, error)

List of convert function types.

type ConvertPrimaryKeyFunc

type ConvertPrimaryKeyFunc func(*sqlspec.PrimaryKey, *schema.Table) (*schema.Index, error)

List of convert function types.

type ConvertTableFunc

type ConvertTableFunc func(*sqlspec.Table, *schema.Schema) (*schema.Table, error)

List of convert function types.

type ConvertTypeFunc

type ConvertTypeFunc func(*sqlspec.Column) (schema.Type, error)

List of convert function types.

type ForeignKeySpecFunc

type ForeignKeySpecFunc func(*schema.ForeignKey) (*sqlspec.ForeignKey, error)

List of convert function types.

type IndexSpecFunc

type IndexSpecFunc func(*schema.Index) (*sqlspec.Index, error)

List of convert function types.

type PrimaryKeySpecFunc

type PrimaryKeySpecFunc func(*schema.Index) (*sqlspec.PrimaryKey, error)

List of convert function types.

type TableSpecFunc

type TableSpecFunc func(*schema.Table) (*sqlspec.Table, error)

List of convert function types.