gorm

Documentation

Index

• func GormV1ToV2Adapter(v1DB *gormv1.DB) (*gormv2.DB, error)
• type DBProvider
• type InsertBatcher
  • func NewInsertBatcher[T any](dbProvider DBProvider, maxBatchSize int, maxWaitTime time.Duration, ...) *InsertBatcher[T]
  • func NewInsertBatcherWithOptions[T any](dbProvider DBProvider, ctx context.Context, opts ...batcher.Option) *InsertBatcher[T]
  • func (b *InsertBatcher[T]) Insert(items ...T) error
  • func (b *InsertBatcher[T]) InsertAsync(callback func(error), items ...T)
• type SelectBatcher
  • func NewSelectBatcher[T any](dbProvider DBProvider, maxBatchSize int, maxWaitTime time.Duration, ...) (*SelectBatcher[T], error)
  • func NewSelectBatcherWithOptions[T any](dbProvider DBProvider, ctx context.Context, columns []string, ...) (*SelectBatcher[T], error)
  • func (b *SelectBatcher[T]) Select(condition string, args ...interface{}) ([]T, error)
  • func (b *SelectBatcher[T]) SelectAsync(callback func([]T, error), condition string, args ...interface{})
• type SelectItem
• type UpdateBatcher
  • func NewUpdateBatcher[T any](dbProvider DBProvider, maxBatchSize int, maxWaitTime time.Duration, ...) (*UpdateBatcher[T], error)
  • func NewUpdateBatcherWithOptions[T any](dbProvider DBProvider, ctx context.Context, opts ...batcher.Option) (*UpdateBatcher[T], error)
  • func (b *UpdateBatcher[T]) Update(items []T, updateFields []string) error
  • func (b *UpdateBatcher[T]) UpdateAsync(callback func(error), items []T, updateFields []string)
• type UpdateItem

Functions

func GormV1ToV2Adapter

func GormV1ToV2Adapter(v1DB *gormv1.DB) (*gormv2.DB, error)

GormV1ToV2Adapter adapts a GORM v1 connection to a GORM v2 connection

Types

type DBProvider

type DBProvider func() (*gorm.DB, error)

DBProvider is a function type that returns the current database connection and an error

type InsertBatcher

type InsertBatcher[T any] struct {
	// contains filtered or unexported fields
}

InsertBatcher is a GORM batcher for batch inserts

func NewInsertBatcher

func NewInsertBatcher[T any](dbProvider DBProvider, maxBatchSize int, maxWaitTime time.Duration, ctx context.Context) *InsertBatcher[T]

NewInsertBatcher creates a new InsertBatcher

func NewInsertBatcherWithOptions

func NewInsertBatcherWithOptions[T any](dbProvider DBProvider, ctx context.Context, opts ...batcher.Option) *InsertBatcher[T]

NewInsertBatcherWithOptions creates a new InsertBatcher with custom options

func (*InsertBatcher[T]) Insert

func (b *InsertBatcher[T]) Insert(items ...T) error

Insert submits one or more items for batch insertion

func (*InsertBatcher[T]) InsertAsync

func (b *InsertBatcher[T]) InsertAsync(callback func(error), items ...T)

InsertAsync non-blocking version of Insert with a callback

type SelectBatcher

type SelectBatcher[T any] struct {
	// contains filtered or unexported fields
}

func NewSelectBatcher

func NewSelectBatcher[T any](dbProvider DBProvider, maxBatchSize int, maxWaitTime time.Duration, ctx context.Context, columns []string) (*SelectBatcher[T], error)

NewSelectBatcher creates a new SelectBatcher

func NewSelectBatcherWithOptions

func NewSelectBatcherWithOptions[T any](dbProvider DBProvider, ctx context.Context, columns []string, opts ...batcher.Option) (*SelectBatcher[T], error)

NewSelectBatcherWithOptions creates a new SelectBatcher with custom options

func (*SelectBatcher[T]) Select

func (b *SelectBatcher[T]) Select(condition string, args ...interface{}) ([]T, error)

func (*SelectBatcher[T]) SelectAsync

func (b *SelectBatcher[T]) SelectAsync(callback func([]T, error), condition string, args ...interface{})

SelectAsync non-blocking version of Select with a callback

type SelectItem

type SelectItem[T any] struct {
	Condition string
	Args      []interface{}
	Results   *[]T
}

type UpdateBatcher

type UpdateBatcher[T any] struct {
	// contains filtered or unexported fields
}

UpdateBatcher is a GORM batcher for batch updates

func NewUpdateBatcher

func NewUpdateBatcher[T any](dbProvider DBProvider, maxBatchSize int, maxWaitTime time.Duration, ctx context.Context) (*UpdateBatcher[T], error)

Legacy constructor calls the new options-based one

func NewUpdateBatcherWithOptions

func NewUpdateBatcherWithOptions[T any](dbProvider DBProvider, ctx context.Context, opts ...batcher.Option) (*UpdateBatcher[T], error)

NewUpdateBatcherWithOptions primary constructor using options

func (*UpdateBatcher[T]) Update

func (b *UpdateBatcher[T]) Update(items []T, updateFields []string) error

Update submits one or more items for batch update

func (*UpdateBatcher[T]) UpdateAsync

func (b *UpdateBatcher[T]) UpdateAsync(callback func(error), items []T, updateFields []string)

UpdateAsync non-blocking version of Update with a callback

type UpdateItem

type UpdateItem[T any] struct {
	Item         T
	UpdateFields []string
}