schema

Documentation

Index

• type Column
• type ForeignKey
• type Index
• type Schema
  • func FromSQL(sqlText string) (*Schema, error)
  • func Load(path string) (*Schema, error)
  • func (s *Schema) Mermaid() string
  • func (s *Schema) String() string
  • func (s *Schema) TableMap() map[string]Table
• type Table

Types

type Column

type Column struct {
	Name    string
	Type    string
	NotNull bool
	Default string
	PK      int
}

type ForeignKey

type ForeignKey struct {
	From  string // column in this table
	Table string // referenced table
	To    string // referenced column
}

ForeignKey describes a single-column relationship from this table to another.

type Index

type Index struct {
	Name   string
	Table  string
	Unique bool
	SQL    string
}

type Schema

type Schema struct {
	Tables []Table
}

func FromSQL

func FromSQL(sqlText string) (*Schema, error)

FromSQL materializes a declarative schema (a body of CREATE statements) into a throwaway database and returns the resulting Schema. This lets a checked-in schema.sql be compared against a live database with the normal diff engine.

func Load

func Load(path string) (*Schema, error)

func (*Schema) Mermaid

func (s *Schema) Mermaid() string

Mermaid renders the schema as a Mermaid erDiagram, suitable for pasting into a README or any Mermaid-aware renderer. Foreign keys become relationships.

func (*Schema) String

func (s *Schema) String() string

func (*Schema) TableMap

func (s *Schema) TableMap() map[string]Table

type Table

type Table struct {
	Name        string
	Columns     []Column
	Indexes     []Index
	ForeignKeys []ForeignKey
}