cDB

Documentation

Index

• Constants
• Variables
• func AddConnection(ctx *gin.Context, name string, connection drivers.DriverInterface) error
• func Client[T DBClient](ctx *gin.Context, name string) T
• func StartTransaction(ctx *gin.Context, name string, f func(ctx *gin.Context, tx *gorm.DB) error) error
• func StartTransactionWithModel(ctx *gin.Context, model ModelInterface, ...) error
• func WithContextModel(ctx *gin.Context, model ModelInterface) *gorm.DB
• func WithContextTable(ctx *gin.Context, model ModelInterface) *gorm.DB
• type DBClient
• type DBComponent
  • func (i *DBComponent) Inject(instance any) bool
  • func (i *DBComponent) InjectConf(config cComponents.ConfigInterface) bool
  • func (i *DBComponent) Listen() []*cComponents.ConfigListener
  • func (i *DBComponent) Load()
• type DBContainer
  • func (i *DBContainer) Get(name string) any
  • func (i *DBContainer) GetConnector(name string) drivers.ConnectorInterface
  • func (i *DBContainer) Is(instance any) bool
  • func (i *DBContainer) Range(f func(instance any))
  • func (i *DBContainer) Remove(name string) bool
  • func (i *DBContainer) Save(instance any) bool
• type DatabaseConf
  • func (i *DatabaseConf) ConfigName() string
  • func (i *DatabaseConf) Decode(data string) error
• type GormBuilder
• type Model
  • func (i Model[T]) CountByConditions(ctx *gin.Context, conditions map[string]any) (total int64, err error)
  • func (i Model[T]) Create(ctx *gin.Context, data T) (err error)
  • func (i Model[T]) CreateOrIgnore(ctx *gin.Context, data T, fields []string) (err error)
  • func (i Model[T]) DeleteByConditions(ctx *gin.Context, conditions map[string]any) (err error)
  • func (i Model[T]) FindByConditions(ctx *gin.Context, conditions map[string]any) (result T, err error)
  • func (i Model[T]) FirstOrCreate(ctx *gin.Context, data T, conditions map[string]any) (created int64, err error)
  • func (i Model[T]) GetByBuilder(ctx *gin.Context, builder GormBuilder) (result []T, err error)
  • func (i Model[T]) GetByConditions(ctx *gin.Context, conditions map[string]any) (result []T, err error)
  • func (i Model[T]) Insert(ctx *gin.Context, data []T) (err error)
  • func (i Model[T]) InsertOrIgnore(ctx *gin.Context, data []T, fields []string) (err error)
  • func (i Model[T]) InsertOrUpdate(ctx *gin.Context, data []T, fields []string) (err error)
  • func (i Model[T]) ListByBuilder(ctx *gin.Context, builder GormBuilder) (result []T, err error)
  • func (i Model[T]) ListByConditions(ctx *gin.Context, conditions map[string]any, page, size int64, order string) (result []T, err error)
  • func (i Model[T]) Save(ctx *gin.Context, data T) (err error)
  • func (i Model[T]) StartTransaction(ctx *gin.Context, f func(ctx *gin.Context, tx *gorm.DB) (err error)) (err error)
  • func (i Model[T]) UpdateByConditions(ctx *gin.Context, conditions map[string]any, fields map[string]any) (err error)
  • func (i Model[T]) UpdateOrCreate(ctx *gin.Context, data T, fields []string) (err error)
• type ModelInterface

Constants

const (
	Context_GormDBTransaction = "gorm.db.transaction"
)

const (
	DatabaseConfigName = "DatabaseConf"
)

Variables

var Component = &DBComponent{}

Functions

func AddConnection

func AddConnection(ctx *gin.Context, name string, connection drivers.DriverInterface) error

func Client

func Client[T DBClient](ctx *gin.Context, name string) T

func StartTransaction

func StartTransaction(ctx *gin.Context, name string, f func(ctx *gin.Context, tx *gorm.DB) error) error

func StartTransactionWithModel

func StartTransactionWithModel(ctx *gin.Context, model ModelInterface, f func(ctx *gin.Context, tx *gorm.DB) error) error

func WithContextModel

func WithContextModel(ctx *gin.Context, model ModelInterface) *gorm.DB

WithContextModel 仅用于 gorm，使用model实体进行查询

func WithContextTable

func WithContextTable(ctx *gin.Context, model ModelInterface) *gorm.DB

WithContextTable 仅用于 gorm，使用table进行查询

Types

type DBClient

type DBClient interface {
	*gorm.DB | *redis.Client | *mgo.Database
}

type DBComponent

type DBComponent struct{}

func (*DBComponent) Inject

func (i *DBComponent) Inject(instance any) bool

func (*DBComponent) InjectConf

func (i *DBComponent) InjectConf(config cComponents.ConfigInterface) bool

func (*DBComponent) Listen

func (i *DBComponent) Listen() []*cComponents.ConfigListener

func (*DBComponent) Load

func (i *DBComponent) Load()

type DBContainer

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

func (*DBContainer) Get

func (i *DBContainer) Get(name string) any

func (*DBContainer) GetConnector

func (i *DBContainer) GetConnector(name string) drivers.ConnectorInterface

func (*DBContainer) Is

func (i *DBContainer) Is(instance any) bool

func (*DBContainer) Range

func (i *DBContainer) Range(f func(instance any))

func (*DBContainer) Remove

func (i *DBContainer) Remove(name string) bool

func (*DBContainer) Save

func (i *DBContainer) Save(instance any) bool

type DatabaseConf

type DatabaseConf struct {
	Connections map[string]drivers.DriverInterface `json:"connections"`
}

func (*DatabaseConf) ConfigName

func (i *DatabaseConf) ConfigName() string

func (*DatabaseConf) Decode

func (i *DatabaseConf) Decode(data string) error

type GormBuilder

type GormBuilder struct {
	Conditions map[string]any
	Page       int64
	Size       int64
	OrderBy    string
	GroupBy    string
}

type Model

type Model[T ModelInterface] struct{}

func (Model[T]) CountByConditions

func (i Model[T]) CountByConditions(ctx *gin.Context, conditions map[string]any) (total int64, err error)

CountByConditions 根据条件统计数量

func (Model[T]) Create

func (i Model[T]) Create(ctx *gin.Context, data T) (err error)

Create 添加单条数据

func (Model[T]) CreateOrIgnore

func (i Model[T]) CreateOrIgnore(ctx *gin.Context, data T, fields []string) (err error)

CreateOrIgnore 新建单条数据或忽略，必须要有唯一索引才生效

func (Model[T]) DeleteByConditions

func (i Model[T]) DeleteByConditions(ctx *gin.Context, conditions map[string]any) (err error)

DeleteByConditions 根据条件删除数据

func (Model[T]) FindByConditions

func (i Model[T]) FindByConditions(ctx *gin.Context, conditions map[string]any) (result T, err error)

FindByConditions 根据条件查询单条数据

func (Model[T]) FirstOrCreate

func (i Model[T]) FirstOrCreate(ctx *gin.Context, data T, conditions map[string]any) (created int64, err error)

FirstOrCreate 查找或新增单条数据

func (Model[T]) GetByBuilder

func (i Model[T]) GetByBuilder(ctx *gin.Context, builder GormBuilder) (result []T, err error)

GetByConditions 根据条件查询多条数据，条件不存在则查询所有数据

func (Model[T]) GetByConditions

func (i Model[T]) GetByConditions(ctx *gin.Context, conditions map[string]any) (result []T, err error)

GetByConditions 根据条件查询多条数据，条件不存在则查询所有数据

func (Model[T]) Insert

func (i Model[T]) Insert(ctx *gin.Context, data []T) (err error)

Insert 批量添加数据

func (Model[T]) InsertOrIgnore

func (i Model[T]) InsertOrIgnore(ctx *gin.Context, data []T, fields []string) (err error)

InsertOrIgnore 批量添加数据，存在则忽略

func (Model[T]) InsertOrUpdate

func (i Model[T]) InsertOrUpdate(ctx *gin.Context, data []T, fields []string) (err error)

InsertOrUpdate 批量添加数据，存在则更新

func (Model[T]) ListByBuilder

func (i Model[T]) ListByBuilder(ctx *gin.Context, builder GormBuilder) (result []T, err error)

ListByBuilder 根据构造器查询

func (Model[T]) ListByConditions

func (i Model[T]) ListByConditions(ctx *gin.Context, conditions map[string]any, page, size int64, order string) (result []T, err error)

ListByConditions 根据条件分页查询

func (Model[T]) Save

func (i Model[T]) Save(ctx *gin.Context, data T) (err error)

Save 根据主键更新或新增数据

func (Model[T]) StartTransaction

func (i Model[T]) StartTransaction(ctx *gin.Context, f func(ctx *gin.Context, tx *gorm.DB) (err error)) (err error)

func (Model[T]) UpdateByConditions

func (i Model[T]) UpdateByConditions(ctx *gin.Context, conditions map[string]any, fields map[string]any) (err error)

UpdateByConditions 根据条件更新数据

func (Model[T]) UpdateOrCreate

func (i Model[T]) UpdateOrCreate(ctx *gin.Context, data T, fields []string) (err error)

UpdateOrCreate 更新或新建单条数据，必须要有唯一索引才生效

type ModelInterface

type ModelInterface interface {
	Connection(ctx *gin.Context) string
	TableName() string
}