orm

Documentation

Index

• Constants
• func DefaultLoggerCfg() logger.Config
• func List() map[string]Factory
• func Register(name string, broker Factory)
• type Client
  • func New(cfg *Config, logs log.Logger) *Client
  • func (c *Client) Close() error
  • func (c *Client) Ping() error
  • func (c *Client) Stats() (r result.Result[sql.DBStats])
  • func (c *Client) Vars() vars.Value
• type Config
  • func DefaultCfg() Config
• type Factory
  • func Get(name string) Factory

Constants

const Name = "orm"

Functions

func DefaultLoggerCfg

func DefaultLoggerCfg() logger.Config

func List

func List() map[string]Factory

func Register

func Register(name string, broker Factory)

Types

type Client

type Client struct {
	*gorm.DB
	TablePrefix string
}

func New

func New(cfg *Config, logs log.Logger) *Client

func (*Client) Close

func (c *Client) Close() error

func (*Client) Ping

func (c *Client) Ping() error

func (*Client) Stats

func (c *Client) Stats() (r result.Result[sql.DBStats])

func (*Client) Vars

func (c *Client) Vars() vars.Value

type Config

type Config struct {
	TablePrefix                              string                 `json:"table_prefix" yaml:"table_prefix"`
	Driver                                   string                 `json:"driver" yaml:"driver"`
	DriverCfg                                map[string]interface{} `json:"driver_config" yaml:"driver_config"`
	SkipDefaultTransaction                   bool                   `json:"skip_default_transaction" yaml:"skip_default_transaction"`
	FullSaveAssociations                     bool                   `json:"full_save_associations" yaml:"full_save_associations"`
	DryRun                                   bool                   `json:"dry_run" yaml:"dry_run"`
	PrepareStmt                              bool                   `json:"prepare_stmt" yaml:"prepare_stmt"`
	DisableAutomaticPing                     bool                   `json:"disable_automatic_ping" yaml:"disable_automatic_ping"`
	DisableForeignKeyConstraintWhenMigrating bool                   `json:"disable_foreign_key_constraint_when_migrating" yaml:"disable_foreign_key_constraint_when_migrating"`
	DisableNestedTransaction                 bool                   `json:"disable_nested_transaction" yaml:"disable_nested_transaction"`
	AllowGlobalUpdate                        bool                   `json:"allow_global_update" yaml:"allow_global_update"`
	QueryFields                              bool                   `json:"query_fields" yaml:"query_fields"`
	CreateBatchSize                          int                    `json:"create_batch_size" yaml:"create_batch_size"`
	MaxConnTime                              time.Duration          `json:"max_conn_time" yaml:"max_conn_time"`
	MaxConnIdle                              int                    `json:"max_conn_idle" yaml:"max_conn_idle"`
	MaxConnOpen                              int                    `json:"max_conn_open" yaml:"max_conn_open"`
}

func DefaultCfg

func DefaultCfg() Config

type Factory

type Factory func(cfg config.Map) gorm.Dialector

func Get

func Get(name string) Factory