model

Documentation

Index

• Constants
• Variables
• func GroupByColumn(indexList []gorm.Index) map[string][]*Index
• type AddMethodOpt
  • func (o AddMethodOpt) Methods() []interface{}
  • func (AddMethodOpt) OptionType() string
• type Column
  • func (c *Column) GetDataType() (fieldtype string)
  • func (c *Column) SetDataTypeMap(m map[string]func(detailType string) (dataType string))
  • func (c *Column) ToField(nullable, coverable, signable bool) *Field
  • func (c *Column) WithNS(jsonTagNS, newTagNS func(columnName string) string)
• type Config
  • func (cfg *Config) GetModelMethods() (methods []interface{})
  • func (cfg *Config) GetNames() (tableName, structName, fileName string)
  • func (cfg *Config) GetSchemaName(db *gorm.DB) string
  • func (cfg *Config) Preprocess() *Config
• type CreateFieldOpt
  • func (o CreateFieldOpt) Operator() func(*Field) *Field
  • func (CreateFieldOpt) OptionType() string
• type Field
  • func (m *Field) EscapeKeyword() *Field
  • func (m *Field) EscapeKeywordFor(keywords KeyWord) *Field
  • func (m *Field) GenType() string
  • func (m *Field) IsRelation() bool
  • func (m *Field) Tags() string
• type FieldConfig
• type FieldOption
• type FilterFieldOpt
  • func (o FilterFieldOpt) Operator() func(*Field) *Field
  • func (FilterFieldOpt) OptionType() string
• type Index
• type KeyWord
  • func (g *KeyWord) Contain(text string) bool
  • func (g *KeyWord) FullMatch(word string) bool
• type MethodConfig
• type MethodOption
• type ModifyFieldOpt
  • func (o ModifyFieldOpt) Operator() func(*Field) *Field
  • func (ModifyFieldOpt) OptionType() string
• type NameStrategy
• type Option
• type SQLBuffer
  • func (s *SQLBuffer) Dump() string
  • func (s *SQLBuffer) WriteSQL(b byte)
• type SchemaNameOpt
• type SourceCode
• type Status

Constants

const (
	// DefaultModelPkg ...
	DefaultModelPkg = "model"
)

Variables

var DOKeywords = KeyWord{
	// contains filtered or unexported fields
}

DOKeywords ...

var GenKeywords = KeyWord{
	// contains filtered or unexported fields
}

GenKeywords ...

var GormKeywords = KeyWord{
	// contains filtered or unexported fields
}

GormKeywords ...

Functions

func GroupByColumn

func GroupByColumn(indexList []gorm.Index) map[string][]*Index

GroupByColumn group columns

Types

type AddMethodOpt

type AddMethodOpt func() (methods []interface{})

AddMethodOpt diy method option

func (AddMethodOpt) Methods

func (o AddMethodOpt) Methods() []interface{}

Methods ...

func (AddMethodOpt) OptionType

func (AddMethodOpt) OptionType() string

OptionType implement for interface Option

type Column

type Column struct {
	gorm.ColumnType
	TableName   string   `gorm:"column:TABLE_NAME"`
	Indexes     []*Index `gorm:"-"`
	UseScanType bool     `gorm:"-"`
	// contains filtered or unexported fields
}

Column table column's info

func (*Column) GetDataType

func (c *Column) GetDataType() (fieldtype string)

GetDataType get data type

func (*Column) SetDataTypeMap

func (c *Column) SetDataTypeMap(m map[string]func(detailType string) (dataType string))

SetDataTypeMap set data type map

func (*Column) ToField

func (c *Column) ToField(nullable, coverable, signable bool) *Field

ToField convert to field

func (*Column) WithNS

func (c *Column) WithNS(jsonTagNS, newTagNS func(columnName string) string)

WithNS with name strategy

type Config

type Config struct {
	ModelPkg    string
	TablePrefix string
	TableName   string
	ModelName   string

	ImportPkgPaths []string
	ModelOpts      []Option

	NameStrategy
	FieldConfig
	MethodConfig
}

Config model configuration

func (*Config) GetModelMethods

func (cfg *Config) GetModelMethods() (methods []interface{})

GetModelMethods get diy method from option

func (*Config) GetNames

func (cfg *Config) GetNames() (tableName, structName, fileName string)

GetNames get names

func (*Config) GetSchemaName

func (cfg *Config) GetSchemaName(db *gorm.DB) string

GetSchemaName get schema name

func (*Config) Preprocess

func (cfg *Config) Preprocess() *Config

Preprocess revise invalid field

type CreateFieldOpt

type CreateFieldOpt ModifyFieldOpt

CreateFieldOpt create field option

func (CreateFieldOpt) Operator

func (o CreateFieldOpt) Operator() func(*Field) *Field

Operator implement for FieldOpt

func (CreateFieldOpt) OptionType

func (CreateFieldOpt) OptionType() string

OptionType implement for interface Option

type Field

type Field struct {
	Name             string
	Type             string
	ColumnName       string
	ColumnComment    string
	MultilineComment bool
	JSONTag          string
	GORMTag          string
	NewTag           string
	OverwriteTag     string
	CustomGenType    string
	Relation         *field.Relation
}

Field user input structures

func (*Field) EscapeKeyword

func (m *Field) EscapeKeyword() *Field

EscapeKeyword escape keyword

func (*Field) EscapeKeywordFor

func (m *Field) EscapeKeywordFor(keywords KeyWord) *Field

EscapeKeywordFor escape for specified keyword

func (*Field) GenType

func (m *Field) GenType() string

GenType ...

func (*Field) IsRelation

func (m *Field) IsRelation() bool

IsRelation ...

func (*Field) Tags

func (m *Field) Tags() string

Tags ...

type FieldConfig

type FieldConfig struct {
	DataTypeMap map[string]func(detailType string) (dataType string)

	FieldNullable     bool // generate pointer when field is nullable
	FieldCoverable    bool // generate pointer when field has default value
	FieldSignable     bool // detect integer field's unsigned type, adjust generated data type
	FieldWithIndexTag bool // generate with gorm index tag
	FieldWithTypeTag  bool // generate with gorm column type tag

	FieldJSONTagNS func(columnName string) string
	FieldNewTagNS  func(columnName string) string

	ModifyOpts []FieldOption
	FilterOpts []FieldOption
	CreateOpts []FieldOption
}

FieldConfig field configuration

type FieldOption

type FieldOption interface {
	Option
	Operator() func(*Field) *Field
}

FieldOption ...

type FilterFieldOpt

type FilterFieldOpt ModifyFieldOpt

FilterFieldOpt filter field option

func (FilterFieldOpt) Operator

func (o FilterFieldOpt) Operator() func(*Field) *Field

Operator implement for FieldOpt

func (FilterFieldOpt) OptionType

func (FilterFieldOpt) OptionType() string

OptionType implement for interface Option

type Index

type Index struct {
	gorm.Index
	Priority int32 `gorm:"column:SEQ_IN_INDEX"`
}

Index table index info

type KeyWord

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

KeyWord ...

func (*KeyWord) Contain

func (g *KeyWord) Contain(text string) bool

Contain contain

func (*KeyWord) FullMatch

func (g *KeyWord) FullMatch(word string) bool

FullMatch full match

type MethodConfig

type MethodConfig struct {
	MethodOpts []MethodOption
}

MethodConfig method configuration

type MethodOption

type MethodOption interface {
	Option
	Methods() (methods []interface{})
}

MethodOption ...

type ModifyFieldOpt

type ModifyFieldOpt func(*Field) *Field

ModifyFieldOpt modify field option

func (ModifyFieldOpt) Operator

func (o ModifyFieldOpt) Operator() func(*Field) *Field

Operator implement for FieldOpt

func (ModifyFieldOpt) OptionType

func (ModifyFieldOpt) OptionType() string

OptionType implement for interface Option

type NameStrategy

type NameStrategy struct {
	SchemaNameOpts []SchemaNameOpt

	TableNameNS func(tableName string) string
	ModelNameNS func(tableName string) string
	FileNameNS  func(tableName string) string
}

NameStrategy name strategy

type Option

type Option interface{ OptionType() string }

Option field option

type SQLBuffer

type SQLBuffer struct{ bytes.Buffer }

SQLBuffer sql buffer

func (*SQLBuffer) Dump

func (s *SQLBuffer) Dump() string

Dump ...

func (*SQLBuffer) WriteSQL

func (s *SQLBuffer) WriteSQL(b byte)

WriteSQL ...

type SchemaNameOpt

type SchemaNameOpt func(*gorm.DB) string

SchemaNameOpt schema name option

type SourceCode

type SourceCode int

SourceCode source code

const (
	// Struct ...
	Struct SourceCode = iota
	// Table ...
	Table
	// Object ...
	Object
)

type Status

type Status int

Status sql status

const (
	// UNKNOWN ...
	UNKNOWN Status = iota
	// SQL ...
	SQL
	// DATA ...
	DATA
	// VARIABLE ...
	VARIABLE
	// IF ...
	IF
	// ELSE ...
	ELSE
	// WHERE ...
	WHERE
	// SET ...
	SET
	// FOR ...
	FOR
	// END ...
	END
)