gen

Documentation

Index

• Constants
• func Register(name string, adapter Instance)
• type Config
• type Generator
  • func NewGenerator(adapterName string, config Config) (adapter Generator, err error)
• type Instance
• type Item
• type ModelGenConfig
• type Primary
  • func (p *Primary) IsEmpty() bool
• type SItem
• type ServiceGenConfig
• type ViewConfig

Constants

const (
	// TypeGormModel - type gorm model gen
	TypeGormModel = "gorm_model"
	// TypeBeegoModel - type beego model gen
	TypeBeegoModel = "beego_model"
	// TypeService - type service gen
	TypeService = "service"
)

Functions

func Register

func Register(name string, adapter Instance)

Register makes a Generator adapter available by the adapter name. If Register is called twice with the same name or if driver is nil, it panics.

Types

type Config

type Config struct {
	Package    string           `json:"package"`
	GenPath    string           `json:"gen_path"`
	AllInOne   bool             `json:"all_in_one"`
	ModelCfg   ModelGenConfig   `json:"model_cfg"`
	ServiceCfg ServiceGenConfig `json:"service_cfg"`
}

Config - init config

type Generator

type Generator interface {
	// Gen - gen file
	Gen() error

	// start gc routine based on config settings.
	StartAndGC(config Config) error
}

Generator interface contains all behaviors for model generator adapter.

func NewGenerator

func NewGenerator(adapterName string, config Config) (adapter Generator, err error)

NewGenerator Create a new Generator driver by adapter name and config setting. it will start gc automatically.

type Instance

type Instance func() Generator

Instance is a function create a new Generator Instance

type Item

type Item struct {
	Name        string                 `json:"name"`
	TableName   string                 `json:"table_name"`
	Relations   []string               `json:"relations"`
	Detail      string                 `json:"detail"`
	Primary     Primary                `json:"primary"`
	DisableMode bool                   `json:"disable_mode"`
	Extend      map[string]interface{} `json:"extend"`
}

Item - gen item

type ModelGenConfig

type ModelGenConfig struct {
	Items        []Item `json:"items"`
	MaxIdleConns int64  `json:"max_idle_conns"`
	MaxOpenConns int64  `json:"set_max_open_conns"`
}

ModelGenConfig - model config

type Primary

type Primary struct {
	Type    string
	Name    string
	Default interface{}
}

Primary - primary key info

func (*Primary) IsEmpty

func (p *Primary) IsEmpty() bool

IsEmpty - check primary is empty

type SItem

type SItem struct {
	Req        interface{}            `json:"req"`
	Dst        interface{}            `json:"dst"`
	Index      int64                  `json:"index"`
	CheckApp   bool                   `json:"check_app"`
	DisableRPC bool                   `json:"disable_rpc"`
	ViewCfg    ViewConfig             `json:"view_cfg"`
	Extend     map[string]interface{} `json:"extend"`
}

SItem - service config item

type ServiceGenConfig

type ServiceGenConfig struct {
	Items       []SItem         `json:"items"`
	ImportPaths []string        `json:"import_paths"`
	IgnoreName  map[string]bool `json:"ignore_name"`
	KeepName    map[string]bool `json:"keep_name"`
}

ServiceGenConfig - service config

type ViewConfig

type ViewConfig struct {
	Enable     bool              `json:"enable"`
	Mapping    map[string]string `json:"mapping"`
	RelMapping map[string]string `json:"relation_mapping"`
}

ViewConfig - view gen config