dialer

package

v0.0.0-...-beb69a8 Latest Latest Go to latest Published: Sep 10, 2025 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jcfug8/daylear

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Dial(p DialParams) (*gorm.DB, error)
func GormOption(opt gorm.Option) fx.Option
func ProvideConfigOptions(opts ...ConfigOption) fx.Option
type Config
- func NewConfig(p ConfigParams) *Config
type ConfigOption
type ConfigParams
type DefaultDialer
- func NewDialer() *DefaultDialer
- func (d *DefaultDialer) Dial(dialect Dialect, config *Config, opts ...gorm.Option) (db *gorm.DB, err error)
type DialParams
type Dialect
type Dialer
type PoolConfigOption
- func NewPoolConfigOption(maxIdleConns, maxOpenConns int, maxConnLifetime, maxConnIdleTime time.Duration) *PoolConfigOption
- func (c *PoolConfigOption) AfterInitialize(db *gorm.DB) error
- func (c *PoolConfigOption) Apply(*gorm.Config) error

Constants ¶

View Source

const (
	ConfigOptionTag = `group:"gormDialerConfigOptions"`
	OptionTag       = `group:"gormOptions"`
	PluginTag       = `group:"gormDialerPlugins"`
)

Fx tags -

Variables ¶

View Source

var Module = fx.Module(
	"gormDialer",
	fx.Provide(
		NewConfig,

		fx.Annotate(
			NewDialer,
			fx.As(new(Dialer)),
		),

		Dial,
	),
)

Module -

Functions ¶

func Dial ¶

func Dial(p DialParams) (*gorm.DB, error)

Dial -

func GormOption ¶

func GormOption(opt gorm.Option) fx.Option

GormOption -

func ProvideConfigOptions ¶

func ProvideConfigOptions(opts ...ConfigOption) fx.Option

ProvideConfigOptions -

Types ¶

type Config ¶

type Config struct {
	*gorm.Config
	// contains filtered or unexported fields
}

Config -

func NewConfig ¶

func NewConfig(p ConfigParams) *Config

NewConfig -

type ConfigOption ¶

type ConfigOption interface {
	// contains filtered or unexported methods
}

ConfigOption -

func AllowGlobalUpdate ¶

func AllowGlobalUpdate() ConfigOption

AllowGlobalUpdate -

func CreateBatchSize ¶

func CreateBatchSize(size int) ConfigOption

CreateBatchSize -

func DisableAutomaticPing ¶

func DisableAutomaticPing() ConfigOption

DisableAutomaticPing -

func DisableForeignKeyConstraintWhenMigrating ¶

func DisableForeignKeyConstraintWhenMigrating() ConfigOption

DisableForeignKeyConstraintWhenMigrating -

func DisableNestedTransaction ¶

func DisableNestedTransaction() ConfigOption

DisableNestedTransaction -

func DryRun ¶

func DryRun() ConfigOption

DryRun -

func FullSaveAssociations ¶

func FullSaveAssociations() ConfigOption

FullSaveAssociations -

func IgnoreRelationshipsWhenMigrating ¶

func IgnoreRelationshipsWhenMigrating() ConfigOption

IgnoreRelationshipsWhenMigrating -

func PrepareStmt ¶

func PrepareStmt() ConfigOption

PrepareStmt -

func QueryFields ¶

func QueryFields() ConfigOption

QueryFields -

func SkipDefaultTransaction ¶

func SkipDefaultTransaction() ConfigOption

SkipDefaultTransaction -

func TranslateError ¶

func TranslateError() ConfigOption

TranslateError -

func WithClauseBuilders ¶

func WithClauseBuilders(builders map[string]clause.ClauseBuilder) ConfigOption

WithClauseBuilders -

func WithConnPool ¶

func WithConnPool(pool gorm.ConnPool) ConfigOption

WithConnPool -

func WithLogger ¶

func WithLogger(log zerolog.Logger, config *glogger.Config) ConfigOption

WithLogger -

func WithNamingStrategy ¶

func WithNamingStrategy(namer schema.Namer) ConfigOption

WithNamingStrategy -

func WithNowFunc ¶

func WithNowFunc(f func() time.Time) ConfigOption

WithNowFunc -

func WithPlugins ¶

func WithPlugins(plugins map[string]gorm.Plugin) ConfigOption

WithPlugins - Note that this will replace/overwrie any plugins which were previously added

type ConfigParams ¶

type ConfigParams struct {
	fx.In

	Log     zerolog.Logger
	Opts    []ConfigOption `group:"gormDialerConfigOptions"`
	Plugins []gorm.Plugin  `group:"gormDialerPlugins"`
}

ConfigParams -

type DefaultDialer ¶

type DefaultDialer struct{}

DefaultDialer -

func NewDialer ¶

func NewDialer() *DefaultDialer

NewDialer -

func (*DefaultDialer) Dial ¶

func (d *DefaultDialer) Dial(dialect Dialect, config *Config, opts ...gorm.Option) (db *gorm.DB, err error)

Dial -

type DialParams ¶

type DialParams struct {
	fx.In

	Config  *Config
	Dialect Dialect
	Dialer  Dialer
	Opts    []gorm.Option `group:"gormOptions"`
}

DialParams -

type Dialect ¶

type Dialect interface {
	Dialector() gorm.Dialector
	Options() []gorm.Option
}

Dialect -

type Dialer ¶

type Dialer interface {
	Dial(Dialect, *Config, ...gorm.Option) (*gorm.DB, error)
}

Dialer -

type PoolConfigOption ¶

type PoolConfigOption struct {
	MaxIdleConns    int
	MaxOpenConns    int
	MaxConnLifetime time.Duration
	MaxConnIdleTime time.Duration
}

PoolConfigOption -

func NewPoolConfigOption ¶

func NewPoolConfigOption(maxIdleConns, maxOpenConns int, maxConnLifetime, maxConnIdleTime time.Duration) *PoolConfigOption

NewPoolConfigOption -

func (*PoolConfigOption) AfterInitialize ¶

func (c *PoolConfigOption) AfterInitialize(db *gorm.DB) error

AfterInitialize implements gorm.Option

func (*PoolConfigOption) Apply ¶

func (c *PoolConfigOption) Apply(*gorm.Config) error

Apply implements gorm.Option

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
dialects
postgres
logger
plugins

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