pgxz

Documentation

Index

• Variables
• func Count[T IModel](db *PgDb, whereSql string, whereArgs ...any) (int64, error)
• func Create(db *PgDb, col ICol) error
• func CreateAndReturn[T IModel](db *PgDb, col ICol) (*T, error)
• func Delete(db *PgDb, col ICol, options ...IOption) (int64, error)
• func GetAll[T any](db *PgDb, col ICol, options ...IOption) ([]T, error)
• func GetOne[T IModel](db *PgDb, col ICol, options ...IOption) (*T, error)
• func GroupBy(sql string) *groupOption
• func Limit(v int64) *limitOption
• func Offset(v int64) *offsetOption
• func OrderBy(sql string) *orderOption
• func Select(sql string) *selectOption
• func Update(db *PgDb, updates ICol, options ...IOption) (int64, error)
• func Where(sql string, args ...any) *whereOption
• type Col
  • func (c *Col) HasKey(key string) bool
  • func (c *Col) Init(km KyeMap)
  • func (c *Col) IsSet(key string) bool
  • func (c *Col) Keys() []string
  • func (c *Col) Mapping() map[string]any
  • func (c *Col) Set(fn string, v any)
  • func (c *Col) SetMust(fn string, v any)
• type ICol
• type IModel
• type IOption
• type IPageParams
• type KyeMap
• type OptionGroup
• type OptionType
• type PageParams
  • func (p PageParams) GetPageNum() int64
  • func (p PageParams) GetPageSize() int64
• type PageResult
  • func Page[T any](db *PgDb, selectSql, filterSql, orderSql string, pageParams IPageParams) (*PageResult[T], error)
• type Pagination
  • func NewPagination(pageParams IPageParams) Pagination
  • func (p *Pagination) Compute(total int64)
  • func (p *Pagination) GetSkipRows() int64
• type PgDb
  • func New(pool *pgxpool.Pool) *PgDb
• type UserPageParams

Variables

var DEBUG = false

Functions

func Count

func Count[T IModel](db *PgDb, whereSql string, whereArgs ...any) (int64, error)

func Create

func Create(db *PgDb, col ICol) error

func CreateAndReturn

func CreateAndReturn[T IModel](db *PgDb, col ICol) (*T, error)

func Delete

func Delete(db *PgDb, col ICol, options ...IOption) (int64, error)

Delete return RowsAffected and error

func GetAll

func GetAll[T any](db *PgDb, col ICol, options ...IOption) ([]T, error)

func GetOne

func GetOne[T IModel](db *PgDb, col ICol, options ...IOption) (*T, error)

func GroupBy

func GroupBy(sql string) *groupOption

func Limit

func Limit(v int64) *limitOption

func Offset

func Offset(v int64) *offsetOption

func OrderBy

func OrderBy(sql string) *orderOption

func Select

func Select(sql string) *selectOption

func Update

func Update(db *PgDb, updates ICol, options ...IOption) (int64, error)

Update return RowsAffected and error

func Where

func Where(sql string, args ...any) *whereOption

Types

type Col

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

func (*Col) HasKey

func (c *Col) HasKey(key string) bool

func (*Col) Init

func (c *Col) Init(km KyeMap)

func (*Col) IsSet

func (c *Col) IsSet(key string) bool

func (*Col) Keys

func (c *Col) Keys() []string

func (*Col) Mapping

func (c *Col) Mapping() map[string]any

func (*Col) Set

func (c *Col) Set(fn string, v any)

func (*Col) SetMust

func (c *Col) SetMust(fn string, v any)

SetMust When setting the value, the value must not nil

type ICol

type ICol interface {
	TableName() string

	Init(km KyeMap)
	Set(fn string, v any)
	SetMust(fn string, v any)

	Keys() []string
	HasKey(k string) bool
	IsSet(k string) bool
	Mapping() map[string]any
	// contains filtered or unexported methods
}

type IModel

type IModel interface {
	TableName() string
}

type IOption

type IOption interface {
	ToSql() string
}

type IPageParams

type IPageParams interface {
	GetPageNum() int64
	GetPageSize() int64
}

type KyeMap

type KyeMap map[string]struct{}

type OptionGroup

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

type OptionType

type OptionType uint8

type PageParams

type PageParams struct {
	PageNum  int64 `json:",omitempty"`
	PageSize int64 `json:",omitempty"`
}

func (PageParams) GetPageNum

func (p PageParams) GetPageNum() int64

func (PageParams) GetPageSize

func (p PageParams) GetPageSize() int64

type PageResult

type PageResult[T any] struct {
	Pagination
	List []T
}

func Page

func Page[T any](db *PgDb, selectSql, filterSql, orderSql string, pageParams IPageParams) (*PageResult[T], error)

type Pagination

type Pagination struct {
	PageNum     int64 // 第几页
	PageSize    int64 // 每页几条
	PageTotal   int64 // 总共几页
	Total       int64 // 总共几条
	IsFirstPage bool  // 是否是第一页
	IsLastPage  bool  // 是否是最后一页
}

func NewPagination

func NewPagination(pageParams IPageParams) Pagination

func (*Pagination) Compute

func (p *Pagination) Compute(total int64)

func (*Pagination) GetSkipRows

func (p *Pagination) GetSkipRows() int64

type PgDb

type PgDb struct {
	*pgxpool.Pool
}

func New

func New(pool *pgxpool.Pool) *PgDb

type UserPageParams

type UserPageParams struct {
	DeptId int64
}