construct

Documentation

Index

• Variables
• func GuessTypeName(ci *schema.ColumnInfo) string
• func IgnoreNotFoundError(err error) error
• func MoveEdge(query *gorm.DB, base uint, offset string) (err error)
• func Paginate(query *gorm.DB, out interface{}, pageno, pagesize int) (total int, err error)
• func ReplaceModelFields(cp *rewrite.CodeParser, node *rewrite.DeclNode, summary ClassSummary)
• func ScanModelDir(dir string)
• type ClassSummary
  • func NewClassSummary(name string) ClassSummary
  • func ReplaceSummary(summary, sub ClassSummary) ClassSummary
  • func (s ClassSummary) GetInnerCode() string
  • func (s ClassSummary) GetSortedFeatures() []string
  • func (s *ClassSummary) ParseFields(cp *rewrite.CodeParser, node *rewrite.DeclNode) int
• type FilterFunc
• type ITableComment
• type ITableName
• type Model
  • func (Model) TableComment() string
• type NestedModel
  • func (n *NestedModel) AddToParent(parent *NestedModel, tbQuery *gorm.DB) error
  • func (n NestedModel) AncestorsFilter(Backward bool) FilterFunc
  • func (n NestedModel) ChildrenFilter(rank uint8) FilterFunc
  • func (n NestedModel) CountChildren() int
  • func (n NestedModel) IsLeaf() bool
• type SqlTag
  • func GuessStructTags(ci *schema.ColumnInfo) *SqlTag
  • func NewSqlTag() *SqlTag
  • func (st *SqlTag) Delete(key string)
  • func (st *SqlTag) Get(key string) (string, bool)
  • func (st *SqlTag) ParseTag(tag reflect.StructTag)
  • func (st *SqlTag) Set(key, val string)
  • func (st *SqlTag) String(head string) string
• type TimeModel

Variables

var ModelClasses = map[string]ClassSummary{
	"base.TimeModel": {
		Name:   "base.TimeModel",
		Import: "github.com/azhai/gozzo-db/construct",
		Alias:  "base",
		Features: []string{
			"CreatedAt time.Time",
			"UpdatedAt time.Time",
			"DeletedAt *time.Time",
		},
		FieldLines: []string{
			"CreatedAt time.Time  `json:\"-\" gorm:\"comment:'创建时间'\"`       // 创建时间",
			"UpdatedAt time.Time  `json:\"-\" gorm:\"comment:'更新时间'\"`       // 更新时间",
			"DeletedAt *time.Time `json:\"-\" gorm:\"index;comment:'删除时间'\"` // 删除时间",
		},
	},
	"*base.NestedModel": {
		Name:   "*base.NestedModel",
		Import: "github.com/azhai/gozzo-db/construct",
		Alias:  "base",
		Features: []string{
			"Lft uint",
			"Rgt uint",
			"Depth uint8",
		},
		FieldLines: []string{
			"Lft   uint  `json:\"-\" gorm:\"not null;default:0;comment:'左边界'\"`          // 左边界",
			"Rgt   uint  `json:\"-\" gorm:\"not null;index;default:0;comment:'右边界'\"`    // 右边界",
			"Depth uint8 `json:\"depth\" gorm:\"not null;index;default:1;comment:'高度'\"` // 高度",
		},
	},
}

Functions

func GuessTypeName

func GuessTypeName(ci *schema.ColumnInfo) string

根据数据库字段类型猜测Go类型，适用于mysql或pgsql

func IgnoreNotFoundError

func IgnoreNotFoundError(err error) error

忽略表中无数据的错误

func MoveEdge

func MoveEdge(query *gorm.DB, base uint, offset string) (err error)

左右边界整体移动

func Paginate

func Paginate(query *gorm.DB, out interface{}, pageno, pagesize int) (total int, err error)

*

• 翻页查询，out参数需要传引用
• 使用方法 total, err := Paginate(query, &rows, pageno, pagesize)

func ReplaceModelFields

func ReplaceModelFields(cp *rewrite.CodeParser, node *rewrite.DeclNode, summary ClassSummary)

func ScanModelDir

func ScanModelDir(dir string)

Types

type ClassSummary

type ClassSummary struct {
	Name          string
	Import, Alias string
	Features      []string

	FieldLines []string
	IsChanged  bool
	// contains filtered or unexported fields
}

func NewClassSummary

func NewClassSummary(name string) ClassSummary

func ReplaceSummary

func ReplaceSummary(summary, sub ClassSummary) ClassSummary

func (ClassSummary) GetInnerCode

func (s ClassSummary) GetInnerCode() string

func (ClassSummary) GetSortedFeatures

func (s ClassSummary) GetSortedFeatures() []string

func (*ClassSummary) ParseFields

func (s *ClassSummary) ParseFields(cp *rewrite.CodeParser, node *rewrite.DeclNode) int

type FilterFunc

type FilterFunc = func(query *gorm.DB) *gorm.DB

*

• 过滤查询
• 使用方法 query = query.Scopes(filters ...FilterFunc)

type ITableComment

type ITableComment interface {
	TableComment() string
}

*

• 数据表注释

type ITableName

type ITableName interface {
	TableName() string
}

*

• 数据表名

type Model

type Model struct {
	ID uint `json:"id" toml:"-" gorm:"primary_key;not null;auto_increment"`
}

*

• 带自增主键的基础Model

func (Model) TableComment

func (Model) TableComment() string

type NestedModel

type NestedModel struct {
	Lft   uint  `json:"-" gorm:"not null;default:0;comment:'左边界'"`          // 左边界
	Rgt   uint  `json:"-" gorm:"not null;index;default:0;comment:'右边界'"`    // 右边界
	Depth uint8 `json:"depth" gorm:"not null;index;default:1;comment:'高度'"` // 高度
}

嵌套集合树

func (*NestedModel) AddToParent

func (n *NestedModel) AddToParent(parent *NestedModel, tbQuery *gorm.DB) error

添加到父节点最末，tbQuery一定要使用db.Table(...)

func (NestedModel) AncestorsFilter

func (n NestedModel) AncestorsFilter(Backward bool) FilterFunc

找出所有直系祖先节点

func (NestedModel) ChildrenFilter

func (n NestedModel) ChildrenFilter(rank uint8) FilterFunc

找出所有子孙节点

func (NestedModel) CountChildren

func (n NestedModel) CountChildren() int

有多少个子孙节点

func (NestedModel) IsLeaf

func (n NestedModel) IsLeaf() bool

是否叶子节点

type SqlTag

type SqlTag struct {
	reflect.StructTag
	// contains filtered or unexported fields
}

StructTag named sql or gorm

func GuessStructTags

func GuessStructTags(ci *schema.ColumnInfo) *SqlTag

根据数据库字段属性设置Struct tags

func NewSqlTag

func NewSqlTag() *SqlTag

func (*SqlTag) Delete

func (st *SqlTag) Delete(key string)

Deletes a tag

func (*SqlTag) Get

func (st *SqlTag) Get(key string) (string, bool)

Returns a tag from the tag data

func (*SqlTag) ParseTag

func (st *SqlTag) ParseTag(tag reflect.StructTag)

func (*SqlTag) Set

func (st *SqlTag) Set(key, val string)

Sets a tag in the tag data map

func (*SqlTag) String

func (st *SqlTag) String(head string) string

转为字符串格式，头通常使用sql或gorm

type TimeModel

type TimeModel struct {
	CreatedAt time.Time  `json:"-" gorm:"comment:'创建时间'"`       // 创建时间
	UpdatedAt time.Time  `json:"-" gorm:"comment:'更新时间'"`       // 更新时间
	DeletedAt *time.Time `json:"-" gorm:"index;comment:'删除时间'"` // 删除时间
}

*

• 时间相关的三个典型字段