gorm

package

v1.5.0 Latest Latest Go to latest Published: Sep 20, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Details

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

Repository

gitcode.com/xiayang/faygo

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Callback(fn func(*gorm.DB) error, session ...*gorm.DB) error
func CallbackByName(dbName string, fn func(*gorm.DB) error, session ...*gorm.DB) error
func DB(name ...string) (*gorm.DB, bool)
func List() map[string]*gorm.DB
func MustDB(name ...string) *gorm.DB
func TransactCallback(fn func(*gorm.DB) error, session ...*gorm.DB) (err error)
func TransactCallbackByName(dbName string, fn func(*gorm.DB) error, session ...*gorm.DB) (err error)
type DBConfig
- func Config(name ...string) (DBConfig, bool)
- func MustConfig(name ...string) DBConfig
type DBService

Constants ¶

View Source

const (
	DATABASE_DIR   = "database/"
	DEFAULTDB_NAME = "default"
)

default constant

Variables ¶

View Source

var (
	// DBCONFIG_FILE config file path
	DBCONFIG_FILE = faygo.ConfigDir() + "gorm.ini"
)

Functions ¶

func Callback ¶

func Callback(fn func(*gorm.DB) error, session ...*gorm.DB) error

Callback uses the `default` database for non-transactional operations.

func CallbackByName ¶

func CallbackByName(dbName string, fn func(*gorm.DB) error, session ...*gorm.DB) error

CallbackByName uses the specified database for non-transactional operations.

func DB ¶

func DB(name ...string) (*gorm.DB, bool)

DB is similar to MustDB, but safe.

func List ¶

func List() map[string]*gorm.DB

List gets the list of database engines

func MustDB ¶

func MustDB(name ...string) *gorm.DB

MustDB gets the specified database engine, or the default DB if no name is specified.

func TransactCallback ¶

func TransactCallback(fn func(*gorm.DB) error, session ...*gorm.DB) (err error)

TransactCallback uses the default database for transactional operations.

func TransactCallbackByName ¶

func TransactCallbackByName(dbName string, fn func(*gorm.DB) error, session ...*gorm.DB) (err error)

TransactCallbackByName uses the `specified` database for transactional operations.

Types ¶

type DBConfig ¶

type DBConfig struct {
	Name         string `ini:"-"`
	Enable       bool   `ini:"enable" comment:"Enable the config section"`
	Driver       string `ini:"driver" comment:"mssql | odbc(mssql) | mysql | mymysql | postgres | sqlite3 | oci8 | goracle"`
	Connstring   string `ini:"connstring" comment:"Connect String"`
	MaxOpenConns int    `ini:"max_open_conns"`
	MaxIdleConns int    `ini:"max_idle_conns"`
	ShowSql      bool   `ini:"show_sql" comment:"print sql"`
}

DBConfig is database connection config

func Config ¶

func Config(name ...string) (DBConfig, bool)

Config is similar to MustConfig, but safe.

func MustConfig ¶

func MustConfig(name ...string) DBConfig

MustConfig gets the configuration information for the specified database, or returns the default if no name is specified.

type DBService ¶

type DBService struct {
	Default *gorm.DB            // the default database engine
	List    map[string]*gorm.DB // database engine list
}

DBService is a database engine object.

Source Files ¶

config.go
helper.go
service.go

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