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

database

package

Go to main page

Versions in this module

v0

v0.1.1

Aug 18, 2025

v0.1.0

Jun 10, 2025

Changes in this version

+ var ErrGORMNotEnabled = errors.New("GORM not enabled - set BEAVER_DB_ORM=gorm or use InitWithGORM()")

+ var ErrInvalidConfig = errors.New("invalid database configuration")

+ var ErrInvalidDriver = errors.New("invalid database driver")

+ var ErrNotInitialized = errors.New("database not initialized")

+ func GORM() (*gorm.DB, error)

+ func InitWithGORM(configs ...Config) error

+ func MustGORM() *gorm.DB

+ func MustInitWithGORM(configs ...Config)

+ func NewGORM(cfg Config, sqlDB *sql.DB) (*gorm.DB, error)

+ func NewSQL(cfg Config) (*sql.DB, error)

+ func NewWithGORM(configs ...Config) (*gorm.DB, error)

+ func WithGORMDeprecated(configs ...Config) (*gorm.DB, error)

type Config

+ AutoMigrate bool

+ ConnMaxIdleTime int

+ Debug bool

+ DisableORMLog bool

+ MigrationsPath string

+ MigrationsTable string

+ Params string

+ TLSConfig string

+ UseORM string

+ type Database struct

+ func WithGORM() *Database

+ func WithPrefix(prefix string) *Database

+ func (db *Database) Close() error

+ func (db *Database) Connect() (*Database, error)

+ func (db *Database) GORM() (*gorm.DB, error)

+ func (db *Database) Init() error

+ func (db *Database) MustGORM() *gorm.DB

+ func (db *Database) Ping() error

+ func (db *Database) PingContext(ctx context.Context) error

+ func (db *Database) SQL() *sql.DB

+ func (db *Database) Stats() sql.DBStats

+ func (db *Database) WithGORM() *Database

+ func (db *Database) WithPrefix(prefix string) *Database

v0.0.4

May 25, 2025

Changes in this version

+ func DB() *gorm.DB

+ func Default() (*gorm.DB, error)

+ func Init(configs ...Config) error

+ func InitFromEnv() error

+ func New(cfg Config) (*gorm.DB, error)

+ func NewFromEnv() (*gorm.DB, error)

+ func Reset()

+ func Shutdown(ctx context.Context) error

+ type Config struct

+ AuthToken string

+ ConnMaxLifetime int

+ Database string

+ Driver string

+ Host string

+ MaxIdleConns int

+ MaxOpenConns int

+ Password string

+ Port string

+ SSLMode string

+ URL string

+ Username string

+ func GetConfig() (*Config, error)