docs

Documentation

Index

• type Format
  • func FormatFromString(s string) (Format, error)
  • func (r Format) String() string
• type Generator
  • func NewGenerator(pluginName string, tables schema.Tables) *Generator
  • func (g *Generator) Generate(dir string, format Format) error

Types

type Format

type Format int

const (
	FormatMarkdown Format = iota
	FormatJSON
)

func FormatFromString

func FormatFromString(s string) (Format, error)

func (Format) String

func (r Format) String() string

type Generator

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

func NewGenerator

func NewGenerator(pluginName string, tables schema.Tables) *Generator

NewGenerator creates a new generator for the given tables. The tables are sorted by name. pluginName is optional and is used in markdown only

func (*Generator) Generate

func (g *Generator) Generate(dir string, format Format) error