Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

gorm

package module

Go to main page

Versions in this module

v1

v1.0.6

Apr 28, 2026

v1.0.5

Apr 28, 2026

v1.0.4

Apr 28, 2026

v1.0.3

Apr 27, 2026

v1.0.2

Apr 27, 2026

v1.0.1

Apr 27, 2026

v1.0.0

Apr 27, 2026

v0

v0.0.22

Apr 25, 2026

Changes in this version

+ func NewGormLogger(l *log.Helper) logger.Interface

+ func RegisterMigrateModel(model interface{})

+ func RegisterMigrateModels(models ...interface{})

+ type Client struct

+ func NewClient(opts ...Option) (*Client, error)

+ func (c *Client) Use(m Mixin)

+ type CountOptions struct

+ Distinct string

+ Scopes []func(*gorm.DB) *gorm.DB

+ Timeout time.Duration

+ type GetMigrateModelsFunc func() []interface

+ type Mixin func(*gorm.DB) error

+ type Option func(*Client)

+ func WithAfterOpen(fn func(*gorm.DB) error) Option

+ func WithAutoMigrate(models ...interface{}) Option

+ func WithBeforeOpen(fn func(*gorm.DB) error) Option

+ func WithConfigStruct(cfg interface{}) Option

+ func WithConnMaxLifetime(connMaxLifetime time.Duration) Option

+ func WithContext(ctx context.Context) Option

+ func WithDSN(dsn string) Option

+ func WithDriverName(name string) Option

+ func WithEnableDbResolver(enable bool) Option

+ func WithEnableMetrics(enable bool) Option

+ func WithEnableMigrate(enable bool) Option

+ func WithEnableTrace(enable bool) Option

+ func WithEnvPrefix(prefix string) Option

+ func WithGetMigrateModels(fn GetMigrateModelsFunc) Option

+ func WithGormConfig(cfg *gorm.Config) Option

+ func WithGormDB(db *gorm.DB) Option

+ func WithLogger(l *log.Helper) Option

+ func WithMaxIdleConns(maxIdleConns int) Option

+ func WithMaxOpenConns(maxOpenConns int) Option

+ func WithMixin(m Mixin) Option

+ func WithMixins(ms ...Mixin) Option

+ func WithPrometheusConfig(cfg prometheus.Config) Option

+ func WithPrometheusDbName(dbName string) Option

+ func WithPrometheusHTTPServerPort(httpServerPort uint32) Option

+ func WithPrometheusLabels(labels map[string]string) Option

+ func WithPrometheusPushAddr(pushAddr string) Option

+ func WithPrometheusPushAuth(user, password string) Option

+ func WithPrometheusRefreshInterval(refreshInterval uint32) Option

+ func WithPrometheusStartServer(startServer bool) Option

+ func WithRawOptions(m RawOptions) Option

+ func WithReplicaDsns(dsn []string) Option

+ func WithTracerProvider(provider trace.TracerProvider) Option

+ func WithTracingAttributes(attrs ...attribute.KeyValue) Option

+ func WithTracingDBSystem(name string) Option

+ func WithTracingOptions(opts ...tracing.Option) Option

+ func WithTracingWithoutMetrics() Option

+ func WithTracingWithoutServerAddress() Option

+ type PagingResult struct

+ Items []*E

+ Total uint64

+ type RawOptions map[string]interface

+ type Repository struct

+ func NewRepository[DTO any, ENTITY any](mapper *mapper.CopierMapper[DTO, ENTITY]) *Repository[DTO, ENTITY]

+ func (r *Repository[DTO, ENTITY]) BatchCreate(ctx context.Context, db *gorm.DB, dtos []*DTO, viewMask *fieldmaskpb.FieldMask) ([]*DTO, error)

+ func (r *Repository[DTO, ENTITY]) Count(ctx context.Context, db *gorm.DB, whereSelectors []func(*gorm.DB) *gorm.DB) (int64, error)

+ func (r *Repository[DTO, ENTITY]) CountWithOptions(ctx context.Context, db *gorm.DB, whereSelectors []func(*gorm.DB) *gorm.DB, ...) (int64, error)

+ func (r *Repository[DTO, ENTITY]) Create(ctx context.Context, db *gorm.DB, dto *DTO, viewMask *fieldmaskpb.FieldMask) (*DTO, error)

+ func (r *Repository[DTO, ENTITY]) CreateX(ctx context.Context, db *gorm.DB, dto *DTO, viewMask *fieldmaskpb.FieldMask) (int64, error)

+ func (r *Repository[DTO, ENTITY]) CreateXWithFilters(ctx context.Context, db *gorm.DB, whereSelectors []func(*gorm.DB) *gorm.DB, ...) (int64, error)

+ func (r *Repository[DTO, ENTITY]) Delete(ctx context.Context, db *gorm.DB, notSoftDelete bool) (int64, error)

+ func (r *Repository[DTO, ENTITY]) DeleteWithFilters(ctx context.Context, db *gorm.DB, whereSelectors []func(*gorm.DB) *gorm.DB) (int64, error)

+ func (r *Repository[DTO, ENTITY]) Exists(ctx context.Context, db *gorm.DB) (bool, error)

+ func (r *Repository[DTO, ENTITY]) ExistsWithFilters(ctx context.Context, db *gorm.DB, whereSelectors []func(*gorm.DB) *gorm.DB) (bool, error)

+ func (r *Repository[DTO, ENTITY]) Get(ctx context.Context, db *gorm.DB, viewMask *fieldmaskpb.FieldMask) (*DTO, error)

+ func (r *Repository[DTO, ENTITY]) GetWithFilters(ctx context.Context, db *gorm.DB, whereSelectors []func(*gorm.DB) *gorm.DB, ...) (*DTO, error)

+ func (r *Repository[DTO, ENTITY]) ListWithPagination(ctx context.Context, db *gorm.DB, req *paginationV1.PaginationRequest) (*PagingResult[DTO], error)

+ func (r *Repository[DTO, ENTITY]) ListWithPaging(ctx context.Context, db *gorm.DB, req *paginationV1.PagingRequest) (*PagingResult[DTO], error)

+ func (r *Repository[DTO, ENTITY]) Only(ctx context.Context, db *gorm.DB, viewMask *fieldmaskpb.FieldMask) (*DTO, error)

+ func (r *Repository[DTO, ENTITY]) SoftDelete(ctx context.Context, db *gorm.DB) (int64, error)

+ func (r *Repository[DTO, ENTITY]) Update(ctx context.Context, db *gorm.DB, dto *DTO, updateMask *fieldmaskpb.FieldMask) (*DTO, error)

+ func (r *Repository[DTO, ENTITY]) UpdateWithFilters(ctx context.Context, db *gorm.DB, whereSelectors []func(*gorm.DB) *gorm.DB, ...) (*DTO, error)

+ func (r *Repository[DTO, ENTITY]) UpdateX(ctx context.Context, db *gorm.DB, dto *DTO, updateMask *fieldmaskpb.FieldMask) (int64, error)

+ func (r *Repository[DTO, ENTITY]) UpdateXWithFilters(ctx context.Context, db *gorm.DB, whereSelectors []func(*gorm.DB) *gorm.DB, ...) (int64, error)

+ func (r *Repository[DTO, ENTITY]) Upsert(ctx context.Context, db *gorm.DB, dto *DTO, updateMask *fieldmaskpb.FieldMask) (*DTO, error)

+ func (r *Repository[DTO, ENTITY]) UpsertWithFilters(ctx context.Context, db *gorm.DB, whereSelectors []func(*gorm.DB) *gorm.DB, ...) (*DTO, error)

+ func (r *Repository[DTO, ENTITY]) UpsertX(ctx context.Context, db *gorm.DB, dto *DTO, updateMask *fieldmaskpb.FieldMask) (int64, error)

+ func (r *Repository[DTO, ENTITY]) UpsertXWithFilters(ctx context.Context, db *gorm.DB, whereSelectors []func(*gorm.DB) *gorm.DB, ...) (int64, error)