gen

Documentation

Index

• type Config
• type Generator
  • func FromConfig(config Config) (*Generator, error)
  • func (g *Generator) Gen() error

Types

type Config

type Config struct {
	// The path to a configuration file in TOML format containing information
	// about the database objects that pggen should generate code for.
	ConfigFilePath string
	// The name of the file to which the output should be written.
	OutputFileName string
	// A list of postgres connection strings to be used to connect to the
	// database. They tried in order until one is found where `DB.Ping` works.
	ConnectionStrings []string
	// A list of var patterns which disable pggen when they match the environment.
	DisableVars []string
	// A list of var patterns which must match against the environment in order for
	// pggen to run.
	EnableVars []string
	// The verbosity level of the code generator. -1 means quiet mode,
	// 0 (the default) means normal mode, and 1 means verbose mode.
	Verbosity int
}

`pggen.Config` contains a collection of configuration options for the the codegenerator

type Generator

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

An instantiation of a pggen codegenerator

func FromConfig

func FromConfig(config Config) (*Generator, error)

func (*Generator) Gen

func (g *Generator) Gen() error

Generate the code that this generator has been configured for