db

Documentation

Index

• func HasDefaultDB(db_key DATABASE_KEY, p Pool[*gorm.DB]) bool
• type DATABASE_KEY
• type DatabasePoolItem
  • func (m *DatabasePoolItem) AutoMigrate() error
  • func (m *DatabasePoolItem) DB() *gorm.DB
  • func (d *DatabasePoolItem) Init() *gorm.DB
  • func (m *DatabasePoolItem) Key() DATABASE_KEY
  • func (m *DatabasePoolItem) Models() []interface{}
  • func (m *DatabasePoolItem) Register(model ...interface{}) error
• type Pool
  • func NewPool(defaultDBItem PoolItem[*gorm.DB]) Pool[*gorm.DB]
• type PoolItem
  • func GetDefaultDatabase(db_key DATABASE_KEY, pool Pool[*gorm.DB]) PoolItem[*gorm.DB]
  • func RegisterDefaultDB(db_key DATABASE_KEY, database *gorm.DB) PoolItem[*gorm.DB]

Functions

func HasDefaultDB

func HasDefaultDB(db_key DATABASE_KEY, p Pool[*gorm.DB]) bool

Types

type DATABASE_KEY

type DATABASE_KEY string

Database key type. This can be used to fetch a database connection from the pool.

const (
	// Default database key.
	DEFAULT_DATABASE_KEY DATABASE_KEY = "default"
)

type DatabasePoolItem

type DatabasePoolItem struct {
	DEFAULT_DATABASE string
	DB_NAME          string
	DB_USER          string
	DB_PASS          string
	DB_HOST          string
	DB_PORT          int
	DB_SSLMODE       string
	Config           *gorm.Config

	DBKey DATABASE_KEY
	// contains filtered or unexported fields
}

func (*DatabasePoolItem) AutoMigrate

func (m *DatabasePoolItem) AutoMigrate() error

func (*DatabasePoolItem) DB

func (m *DatabasePoolItem) DB() *gorm.DB

func (*DatabasePoolItem) Init

func (d *DatabasePoolItem) Init() *gorm.DB

func (*DatabasePoolItem) Key

func (m *DatabasePoolItem) Key() DATABASE_KEY

func (*DatabasePoolItem) Models

func (m *DatabasePoolItem) Models() []interface{}

func (*DatabasePoolItem) Register

func (m *DatabasePoolItem) Register(model ...interface{}) error

type Pool

type Pool[T any] interface {
	Add(DB PoolItem[T]) error
	Get(DB_KEY DATABASE_KEY) (PoolItem[T], error)
	ByModel(model interface{}) (PoolItem[T], error)
	Delete(DB_KEY DATABASE_KEY)
	AutoMigrate() error
	Register(DB_KEY DATABASE_KEY, model ...interface{}) error
	GetDefaultDB() PoolItem[T]
	Databases() []PoolItem[T]
}

A pool of database connections.

func NewPool

func NewPool(defaultDBItem PoolItem[*gorm.DB]) Pool[*gorm.DB]

type PoolItem

type PoolItem[T any] interface {
	Key() DATABASE_KEY
	DB() T
	Models() []interface{}
	Register(model ...interface{}) error
	AutoMigrate() error
}

func GetDefaultDatabase

func GetDefaultDatabase(db_key DATABASE_KEY, pool Pool[*gorm.DB]) PoolItem[*gorm.DB]

func RegisterDefaultDB

func RegisterDefaultDB(db_key DATABASE_KEY, database *gorm.DB) PoolItem[*gorm.DB]