sdgorm

package

v0.1.6 Latest Latest Go to latest Published: Mar 16, 2024 License: MIT Imports: 27 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/gaorx/stardust5

Links

Open Source Insights

Documentation ¶

Overview ¶

Package sdgorm GORM扩展

Index ¶

Variables
func Create(tx *gorm.DB, row any) (int64, error)
func CreateAndTake[T any](tx *gorm.DB, row T, q any, args ...any) (T, error)
func CreateInBatches(tx *gorm.DB, rows any, opts *CreateInBatchesOptions) (int64, error)
func Delete[T any](tx *gorm.DB, conds ...any) (int64, error)
func Dial(addr Address, config *gorm.Config) (*gorm.DB, error)
func Exec(tx *gorm.DB, q string, values ...any) (int64, error)
func Exists[T any](tx *gorm.DB, conds ...any) (bool, error)
func Find[T any](tx *gorm.DB, conds ...any) ([]T, error)
func First[T any](tx *gorm.DB, conds ...any) (T, error)
func Last[T any](tx *gorm.DB, conds ...any) (T, error)
func LoggerOf(name string) gormlogger.Interface
func Modify[T any](tx *gorm.DB, modifier func(T) T, q any, args ...any) (int64, error)
func ModifyAndTake[T any](tx *gorm.DB, modifier func(T) T, q any, args ...any) (T, error)
func MustMapper[M any](asPrimitive bool) func(sdjson.Object) (M, error)
func MustMapperToAny[M any](asPrimitive bool) func(sdjson.Object) (any, error)
func NewMapper[M any](asPrimitive bool) (func(sdjson.Object) (M, error), error)
func NewMapperToAny[M any](asPrimitive bool) (func(sdjson.Object) (any, error), error)
func Raw[T any](tx *gorm.DB, q string, values ...any) (T, error)
func RowExists[T any](_ T, err error) (bool, error)
func Scan[T any](tx *gorm.DB) (T, error)
func Take[T any](tx *gorm.DB, conds ...any) (T, error)
func Transaction[R any](db *gorm.DB, action func(tx *gorm.DB) (R, error), opts ...*sql.TxOptions) (R, error)
func UpdateColumns[T any](tx *gorm.DB, colVals map[string]any, q any, args ...any) (int64, error)
func UpdateColumnsAndTake[T any](tx *gorm.DB, colVals map[string]any, q any, args ...any) (T, error)
type Address
type CreateInBatchesOptions
type Page
- func Page0(num, size int) Page
- func Page1(num, size int) Page
- func (p Page) LimitOffset() (int, int)
- func (p Page) Scope() func(*gorm.DB) *gorm.DB
- func (p Page) Sql() string
- func (p Page) TrimNum() int
- func (p Page) WithDefaultSize(defaultSize int) Page
- func (p Page) Wrap(rawSql string) string
type PagingResult
- func FindPaging[T any](builder func() *gorm.DB, p Page) (*PagingResult[T], error)
- func NewPagingResultTo[T, R any](pr *PagingResult[T], rows []R) *PagingResult[R]
- func PageRows[T any](rows []T, page Page) *PagingResult[T]
- func RawPaging[T any](tx *gorm.DB, selectSql string, args map[string]any, p Page) (*PagingResult[T], error)
type Schema
- func ParseSchema(model any, namer schema.Namer) (Schema, error)
- func (s Schema) DBFieldNames() []string
- func (s Schema) IsNil() bool

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	LoggerDiscard        = gormlogger.Discard
	LoggerGormDefault    = gormlogger.Default
	LoggerPlainInfo      = newGormLogger(gormlogger.Info, false)
	LoggerPlainWarn      = newGormLogger(gormlogger.Warn, false)
	LoggerPlainError     = newGormLogger(gormlogger.Error, false)
	LoggerPlainSilent    = newGormLogger(gormlogger.Silent, false)
	LoggerColorfulInfo   = newGormLogger(gormlogger.Info, true)
	LoggerColorfulWarn   = newGormLogger(gormlogger.Warn, true)
	LoggerColorfulError  = newGormLogger(gormlogger.Error, true)
	LoggerColorfulSilent = newGormLogger(gormlogger.Silent, true)
	LoggerBuiltin        = newBuiltinLogger(200 * time.Millisecond)
)

View Source

var (
	ErrIllegalDriver = sderr.Sentinel("illegal driver")
)

Functions ¶

func Create ¶

func Create(tx *gorm.DB, row any) (int64, error)

func CreateAndTake ¶

func CreateAndTake[T any](tx *gorm.DB, row T, q any, args ...any) (T, error)

func CreateInBatches ¶

func CreateInBatches(tx *gorm.DB, rows any, opts *CreateInBatchesOptions) (int64, error)

func Delete ¶

func Delete[T any](tx *gorm.DB, conds ...any) (int64, error)

func Dial ¶

func Dial(addr Address, config *gorm.Config) (*gorm.DB, error)

func Exec ¶

func Exec(tx *gorm.DB, q string, values ...any) (int64, error)

func Exists ¶

func Exists[T any](tx *gorm.DB, conds ...any) (bool, error)

func Find ¶

func Find[T any](tx *gorm.DB, conds ...any) ([]T, error)

func First ¶

func First[T any](tx *gorm.DB, conds ...any) (T, error)

func Last ¶

func Last[T any](tx *gorm.DB, conds ...any) (T, error)

func LoggerOf ¶

func LoggerOf(name string) gormlogger.Interface

func Modify ¶

func Modify[T any](tx *gorm.DB, modifier func(T) T, q any, args ...any) (int64, error)

func ModifyAndTake ¶

func ModifyAndTake[T any](tx *gorm.DB, modifier func(T) T, q any, args ...any) (T, error)

func MustMapper ¶

func MustMapper[M any](asPrimitive bool) func(sdjson.Object) (M, error)

func MustMapperToAny ¶

func MustMapperToAny[M any](asPrimitive bool) func(sdjson.Object) (any, error)

func NewMapper ¶

func NewMapper[M any](asPrimitive bool) (func(sdjson.Object) (M, error), error)

func NewMapperToAny ¶

func NewMapperToAny[M any](asPrimitive bool) (func(sdjson.Object) (any, error), error)

func Raw ¶

func Raw[T any](tx *gorm.DB, q string, values ...any) (T, error)

func RowExists ¶

func RowExists[T any](_ T, err error) (bool, error)

func Scan ¶

func Scan[T any](tx *gorm.DB) (T, error)

func Take ¶

func Take[T any](tx *gorm.DB, conds ...any) (T, error)

func Transaction ¶

func Transaction[R any](db *gorm.DB, action func(tx *gorm.DB) (R, error), opts ...*sql.TxOptions) (R, error)

func UpdateColumns ¶

func UpdateColumns[T any](tx *gorm.DB, colVals map[string]any, q any, args ...any) (int64, error)

func UpdateColumnsAndTake ¶

func UpdateColumnsAndTake[T any](tx *gorm.DB, colVals map[string]any, q any, args ...any) (T, error)

Types ¶

type Address ¶

type Address struct {
	// common
	Driver string `json:"driver" toml:"driver" yaml:"driver"`
	DSN    string `json:"dsn" toml:"dsn" yaml:"dsn"`
	Logger string `json:"logger" toml:"logger"`

	// mysql
	MySqlConn                      gorm.ConnPool `json:"-" toml:"-"`
	MySqlSkipInitializeWithVersion bool          `json:"mysql_skip_initialize_with_version" toml:"mysql_skip_initialize_with_version" yaml:"mysql_skip_initialize_with_version"`
	MySqlDefaultStringSize         uint          `json:"mysql_default_string_size" toml:"mysql_default_string_size" yaml:"mysql_default_string_size"`
	MySqlDefaultDatetimePrecision  *int          `json:"mysql_default_datetime_precision" toml:"mysql_default_datetime_precision" yaml:"mysql_default_datetime_precision"`
	MySqlDisableDatetimePrecision  bool          `json:"mysql_disable_datetime_precision" toml:"mysql_disable_datetime_precision" yaml:"mysql_disable_datetime_precision"`
	MySqlDontSupportRenameIndex    bool          `json:"mysql_dont_support_rename_index" toml:"mysql_dont_support_rename_index" yaml:"mysql_dont_support_rename_index"`
	MySqlDontSupportRenameColumn   bool          `json:"mysql_dont_support_rename_column" toml:"mysql_dont_support_rename_column" yaml:"mysql_dont_support_rename_column"`
	MySqlDontSupportForShareClause bool          `` /* 128-byte string literal not displayed */

	// postgres
	PostgresConn                 *sql.DB `json:"-" toml:"-"`
	PostgresPreferSimpleProtocol bool    `json:"postgres_prefer_simple_protocol" toml:"postgres_prefer_simple_protocol" yaml:"postgres_prefer_simple_protocol"`
	PostgresWithoutReturning     bool    `json:"postgres_without_returning" toml:"postgres_without_returning" yaml:"postgres_without_returning"`
}

type CreateInBatchesOptions ¶

type CreateInBatchesOptions struct {
	Table     string // 可以指定表名，如果为空，则使用model中表名
	Clear     bool   // 在插入数据前删除表中所有数据(危险操作)
	Overwrite bool   // 如果为true，如果表中存在相同ID的行，则覆盖掉原来的行；否则不修改任何数据
}

type Page ¶

type Page struct {
	Num  int
	Size int
	// contains filtered or unexported fields
}

func Page0 ¶

func Page0(num, size int) Page

func Page1 ¶

func Page1(num, size int) Page

func (Page) LimitOffset ¶

func (p Page) LimitOffset() (int, int)

func (Page) Scope ¶

func (p Page) Scope() func(*gorm.DB) *gorm.DB

func (Page) Sql ¶

func (p Page) Sql() string

func (Page) TrimNum ¶

func (p Page) TrimNum() int

func (Page) WithDefaultSize ¶

func (p Page) WithDefaultSize(defaultSize int) Page

func (Page) Wrap ¶

func (p Page) Wrap(rawSql string) string

type PagingResult ¶

type PagingResult[T any] struct {
	Rows      []T
	NumRows   int
	PageSize  int
	PageNum   int
	PageTotal int
}

func FindPaging ¶

func FindPaging[T any](builder func() *gorm.DB, p Page) (*PagingResult[T], error)

func NewPagingResultTo ¶

func NewPagingResultTo[T, R any](pr *PagingResult[T], rows []R) *PagingResult[R]

func PageRows ¶

func PageRows[T any](rows []T, page Page) *PagingResult[T]

func RawPaging ¶

func RawPaging[T any](tx *gorm.DB, selectSql string, args map[string]any, p Page) (*PagingResult[T], error)

type Schema ¶

type Schema struct {
	*schema.Schema
}

func ParseSchema ¶

func ParseSchema(model any, namer schema.Namer) (Schema, error)

func (Schema) DBFieldNames ¶

func (s Schema) DBFieldNames() []string

func (Schema) IsNil ¶

func (s Schema) IsNil() bool

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL