config

Documentation

Index

• Constants
• type DatabaseConf
  • func (c DatabaseConf) Check() error
  • func (c DatabaseConf) GetDSN() string
  • func (c DatabaseConf) InitDatabase(conf logx.LogConf) (*gorm.DB, error)
• type RedisConf
  • func (r RedisConf) MustNewUniversalRedis() redis.UniversalClient
  • func (r RedisConf) NewUniversalRedis() (redis.UniversalClient, error)
  • func (r RedisConf) Validate() error
• type StorageConf

Constants

const RedisCaptchaPrefix = "CAPTCHA:"

Types

type DatabaseConf

type DatabaseConf struct {
	Type          string `json:",default=mysql,options=[mysql,postgres,sqlite3],env=DATABASE_TYPE"`
	Host          string `json:",env=DATABASE_HOST"`
	Port          int    `json:",env=DATABASE_PORT"`
	Username      string `json:",default=root,env=DATABASE_USERNAME"`
	Password      string `json:",optional,env=DATABASE_PASSWORD"`
	DBName        string `json:",default=test_db,env=DATABASE_DBNAME"`
	Config        string `json:",optional,env=DATABASE_CONFIG"`
	MaxIdleConn   int    `json:",optional,default=10,env=DATABASE_MAX_IDLE_CONN"`
	MaxOpenConn   int    `json:",optional,default=100,env=DATABASE_MAX_OPEN_CONN"`
	ConnMaxLife   int    `json:",optional,default=3600,env=DATABASE_CONN_MAX_LIFE"`
	Prefix        string `json:",default=cmf_,env=DATABASE_PREFIX"`
	DBPath        string `json:",optional,env=DATABASE_DBPATH"`
	LogMode       string `json:",default=error,env=DATABASE_LOG_MODE"`        // 日志级别
	EnableLogFile bool   `json:",default=false,env=DATABASE_ENABLE_LOG_FILE"` // 是否启用日志文件
	LogFilename   string `json:",default=db.log,env=DATABASE_LOG_FILENAME"`   // 日志文件名称
}

DatabaseConf 结构体存储数据库配置

func (DatabaseConf) Check

func (c DatabaseConf) Check() error

func (DatabaseConf) GetDSN

func (c DatabaseConf) GetDSN() string

GetDSN 根据数据库类型返回 DSN

func (DatabaseConf) InitDatabase

func (c DatabaseConf) InitDatabase(conf logx.LogConf) (*gorm.DB, error)

InitDatabase 初始化数据库连接

type RedisConf

type RedisConf struct {
	Host     string `json:",env=REDIS_HOST"`
	Db       int    `json:",default=0,env=REDIS_DB"`
	Username string `json:",optional,env=REDIS_USERNAME"`
	Pass     string `json:",optional,env=REDIS_PASSWORD"`
	Tls      bool   `json:",optional,env=REDIS_TLS"`
	Master   string `json:",optional,env=REDIS_MASTER"`
}

A RedisConf is a redis config.

func (RedisConf) MustNewUniversalRedis

func (r RedisConf) MustNewUniversalRedis() redis.UniversalClient

func (RedisConf) NewUniversalRedis

func (r RedisConf) NewUniversalRedis() (redis.UniversalClient, error)

func (RedisConf) Validate

func (r RedisConf) Validate() error

type StorageConf

type StorageConf struct {
	Driver string `json:",default=local,options=[local,oss]"` // local/oss
	Local  struct {
		Directory string `json:",default=storage"`
		BaseUrl   string `json:",optional"`
	} `json:",optional"`
	Oss struct {
		Endpoint        string `json:",optional"`
		AccessKeyID     string `json:",optional"`
		AccessKeySecret string `json:",optional"`
		BucketName      string `json:",optional"`
		BucketURL       string `json:",optional"`
	} `json:",optional"`
}

var GlobalStorage StorageConf