base

Documentation

Index

• Constants
• func AddFlags(command *cobra.Command)
• func CreateCommand(name, description string, generator Gen) *cobra.Command
• func ReadFlags(command *cobra.Command) (conn, output, pkg string, tables []string, followFKs bool, genOrm bool, ...)
• type Gen
• type Generator
  • func NewGenerator(url string) Generator
  • func (g Generator) Generate(tables []string, followFKs, useSQLNulls bool, output, tmpl string, ...) error
  • func (g Generator) GenerateFromEntities(entities []model.Entity, output, tmpl string, packer Packer) error
• type Options
  • func (o *Options) Def()
• type Packer

Constants

const (
	// Conn is connection string (-c) basic flag
	Conn = "conn"

	// Output is output filename (-o) basic flag
	Output = "output"

	// Tables is basic flag (-t) for tables to generate
	Tables = "tables"

	// FollowFKs is basic flag (-f) for generate foreign keys models for selected tables
	FollowFKs = "follow-fk"

	// Package for model files
	Pkg = "pkg"
)

Functions

func AddFlags

func AddFlags(command *cobra.Command)

AddFlags adds basic flags to command

func CreateCommand

func CreateCommand(name, description string, generator Gen) *cobra.Command

CreateCommand creates cobra command

func ReadFlags

func ReadFlags(command *cobra.Command) (conn, output, pkg string, tables []string, followFKs bool, genOrm bool, dbWrapName string, customTypes model.CustomTypeMapping, err error)

ReadFlags reads basic flags from command

Types

type Gen

type Gen interface {
	AddFlags(command *cobra.Command)
	ReadFlags(command *cobra.Command) error

	Generate() error
}

Gen is interface for all generators

type Generator

type Generator struct {
	bungen.Bungen
}

Generator is base generator used in other generators

func NewGenerator

func NewGenerator(url string) Generator

NewGenerator creates generator

func (Generator) Generate

func (g Generator) Generate(tables []string, followFKs, useSQLNulls bool, output, tmpl string, packer Packer, customTypes model.CustomTypeMapping) error

Generate runs whole generation process

func (Generator) GenerateFromEntities

func (g Generator) GenerateFromEntities(entities []model.Entity, output, tmpl string, packer Packer) error

type Options

type Options struct {
	// URL connection string
	URL string

	// Output file path
	Output string

	// List of Tables to generate
	// Default []string{"public.*"}
	Tables []string

	// Generate model for foreign keys,
	// even if Tables not listed in Tables param
	// will not generate fks if schema not listed
	FollowFKs bool

	// Custom types goes here
	CustomTypes model.CustomTypeMapping

	// Generate basic ORM queries
	GenORM bool

	// Struct name for ORM queries. Works only when GenORM == true
	DBWrapName string
}

Options is common options for all generators

func (*Options) Def

func (o *Options) Def()

Def sets default options if empty

type Packer

type Packer func(entities []model.Entity) (interface{}, error)

Packer is a function that compile entities to package