database

package

v1.4.31 Latest Latest Go to latest Published: May 22, 2026 License: MIT Imports: 18 Imported by: 0

Details

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

Repository

github.com/18721889353/sunshine

Links

Open Source Insights

Documentation ¶

Overview ¶

Package database 数据库层提供 MySQL、Redis、RabbitMQ、Elasticsearch 等数据源的初始化和连接管理

Package database provides database client initialization.

Index ¶

Constants
Variables
func CloseDB() error
func CloseElasticsearch() error
func CloseRedis() error
func GenerateOrderNo(prefix string, snowID snowflake.ID) string
func GetDB() *sgorm.DB
func GetElasticsearch() *es.Client
func GetMainRabbitMQ() *gorabbitmqclient.RabbitMQ
func GetRedisCli() *goredis.Client
func GetSequenceFromSnowID(id snowflake.ID) int64
func GetSnowID() snowflake.ID
func GetSnowNode() *snowflake.Node
func GetTimeFromSnowID(id snowflake.ID) time.Time
func InitCache(cType string)
func InitDB()
func InitElasticsearch() *es.Client
func InitMysql() *sgorm.DB
func InitRabbitmq()
func InitRedis()
func InitSnowNode()
func IsSnowflakeID(id string) bool
func ParseSnowID(id snowflake.ID) map[string]int64
type CacheType
- func GetCacheType() *CacheType

Constants ¶

View Source

const (
	// MQMAIN 本项目主MQ实例名称
	MQMAIN = "main"
)

View Source

const (
	// SnowflakeIDLength 雪花算法生成的ID长度（19位十进制数字）
	SnowflakeIDLength = 19
)

Variables ¶

View Source

var (
	// ErrCacheNotFound 未命中缓存
	ErrCacheNotFound = goredis.ErrRedisNotFound
)

View Source

var (

	// ErrRecordNotFound 记录未找到错误
	ErrRecordNotFound = sgorm.ErrRecordNotFound
)

Functions ¶

func CloseDB ¶

func CloseDB() error

CloseDB close db

func CloseElasticsearch ¶ added in v1.3.12

func CloseElasticsearch() error

CloseElasticsearch 关闭ES客户端（空实现，仅为了保持接口一致性）

func CloseRedis ¶

func CloseRedis() error

CloseRedis 关闭 Redis 连接

func GenerateOrderNo ¶ added in v1.3.6

func GenerateOrderNo(prefix string, snowID snowflake.ID) string

GenerateOrderNo 生成带有业务含义的订单号

func GetDB ¶

func GetDB() *sgorm.DB

GetDB get db

func GetElasticsearch ¶ added in v1.3.12

func GetElasticsearch() *es.Client

GetElasticsearch 获取ES客户端实例

func GetMainRabbitMQ ¶ added in v1.4.10

func GetMainRabbitMQ() *gorabbitmqclient.RabbitMQ

GetMainRabbitMQ 获取本项目 MQ 实例

func GetRedisCli ¶

func GetRedisCli() *goredis.Client

GetRedisCli 获取 Redis 客户端

func GetSequenceFromSnowID ¶ added in v1.4.27

func GetSequenceFromSnowID(id snowflake.ID) int64

GetSequenceFromSnowID 从雪花ID中提取序列号

func GetSnowID ¶ added in v1.4.27

func GetSnowID() snowflake.ID

GetSnowID 获取雪花ID

func GetSnowNode ¶

func GetSnowNode() *snowflake.Node

GetSnowNode get db

func GetTimeFromSnowID ¶ added in v1.4.27

func GetTimeFromSnowID(id snowflake.ID) time.Time

GetTimeFromSnowID 从雪花ID中获取时间

func InitCache ¶

func InitCache(cType string)

InitCache 初始化缓存

func InitDB ¶

func InitDB()

InitDB connect database

func InitElasticsearch ¶ added in v1.3.12

func InitElasticsearch() *es.Client

InitElasticsearch 初始化Elasticsearch客户端

func InitMysql ¶

func InitMysql() *sgorm.DB

InitMysql connect mysql

func InitRabbitmq ¶ added in v1.3.22

func InitRabbitmq()

InitRabbitmq 确保在程序启动时配置被加载并初始化连接池

func InitRedis ¶

func InitRedis()

InitRedis 连接 Redis

func InitSnowNode ¶

func InitSnowNode()

InitSnowNode connect redis

func IsSnowflakeID ¶ added in v1.4.29

func IsSnowflakeID(id string) bool

IsSnowflakeID 判断字符串是否是雪花算法生成的ID（19位纯数字）用于区分 Go Producer（雪花ID）和其他语言/系统（UUID或其他格式）发送的消息注意：此函数仅做格式校验，不做数值范围校验

func ParseSnowID ¶ added in v1.4.27

func ParseSnowID(id snowflake.ID) map[string]int64

ParseSnowID 解析雪花ID的各个组成部分

Types ¶

type CacheType ¶

type CacheType struct {
	CType string          // 缓存类型 memory 或 redis
	Rdb   *goredis.Client // 如果 CType=redis，则 Rdb 不能为空
}

CacheType 缓存类型

func GetCacheType ¶

func GetCacheType() *CacheType

GetCacheType 获取缓存类型

Source Files ¶

View all Source files

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