Skip to main content
Version: 2.7.x(Latest)

我们推荐使用配置组件来管理数据库配置，并使用 g 对象管理模块中的 g.DB("数据库分组名称") 方法获取数据库操作对象，数据库对象将会自动读取配置组件中的相应配置项，并自动初始化该数据库操作的单例对象。数据库配置管理功能使用的是配置管理组件实现（配置组件采用接口化设计默认使用文件系统实现），同样支持多种数据格式如： toml/yaml/json/xml/ini/properties。默认并且推荐的配置文件数据格式为 yaml。

简单配置​

tip

从 v2.2.0 版本开始，使用 link 进行数据库配置时，数据库组件统一了不同数据库类型的配置格式，以简化配置管理。

简化配置通过配置项 link 指定，格式如下：

type:username:password@protocol(address)[/dbname][?param1=value1&...&paramN=valueN]

即：

类型:账号:密码@协议(地址)/数据库名称?特性配置

其中：

  • 数据库名称 及 特性配置 为非必须参数，其他参数为必须参数。
  • 协议 可选配置为： tcp/udp/unix/file，常见配置为 tcp
  • 特性配置 根据不同的数据库类型，由其底层实现的第三方驱动定义，具体需要参考第三方驱动官网。例如，针对 mysql 驱动而言，使用的第三方驱动为： https://github.com/go-sql-driver/mysql 支持的特性配置如 multiStatements 和 loc 等。

示例：

database:
  default:
    link:  "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
  user:
    link:  "sqlite::@file(/var/data/db.sqlite3)"
  local:
    link:  "mysql:username:password@unix(/tmp/mysql.sock)/dbname"

不同数据类型对应的 link 示例如下：

类型link示例extra参数
mysqlmysql:root:12345678@tcp(127.0.0.1:3306)/test?loc=Local&parseTime=truemysql
mariadbmariadb:root:12345678@tcp(127.0.0.1:3306)/test?loc=Local&parseTime=truemysql
tidbtidb:root:12345678@tcp(127.0.0.1:3306)/test?loc=Local&parseTime=truemysql
pgsqlpgsql:root:12345678@tcp(127.0.0.1:5432)/testpq
mssqlmssql:root:12345678@tcp(127.0.0.1:1433)/test?encrypt=disablego-mssqldb
sqlitesqlite::@file(/var/data/db.sqlite3)pure go:go-sqlite
32bit-cgo:go-sqlite3
oracleoracle:root:12345678@tcp(127.0.0.1:5432)/testgo-ora
clickhouseclickhouse:root:12345678@tcp(127.0.0.1:9000)/testclickhouse-go
dmdm:root:12345678@tcp(127.0.0.1:5236)/testdm
tip

更多框架支持的数据库类型请参考： https://github.com/gogf/gf/tree/master/contrib/drivers

完整配置​

完整的 config.yaml 数据库配置项的数据格式形如下：

database:
  default:                      # 分组名称，可自定义，默认为default
    host: "127.0.0.1"           # 地址
    port: "3306"                # 端口
    user: "root"                # 账号
    pass: "your_password"       # 密码
    name: "your_database"       # 数据库名称
    type: "mysql"               # 数据库类型(如：mariadb/tidb/mysql/pgsql/mssql/sqlite/oracle/clickhouse/dm)
    link: ""                    # (可选)自定义数据库链接信息，当该字段被设置值时，以上链接字段(Host,Port,User,Pass,Name,Type)将失效
    extra: ""                   # (可选)不同数据库的额外特性配置，由底层数据库driver定义，具体有哪些配置请查看具体的数据库driver介绍
    role: "master"              # (可选)数据库主从角色(master/slave)，默认为master。如果不使用应用主从机制请不配置或留空即可。
    debug: false                # (可选)开启调试模式
    prefix: "gf_"               # (可选)表名前缀
    dryRun: false               # (可选)ORM空跑(只读不写)
    charset: "utf8"             # (可选)数据库编码(如: utf8mb4/utf8/gbk/gb2312)，一般设置为utf8mb4。默认为utf8。
    protocol: "tcp"             # (可选)数据库连接协议，默认为TCP
    weight: 100                 # (可选)负载均衡权重，用于负载均衡控制，不使用应用层的负载均衡机制请置空
    timezone: "Local"           # (可选)时区配置，例如:Local
    namespace: ""               # (可选)用以支持个别数据库服务Catalog&Schema区分的问题，原有的Schema代表数据库名称，而NameSpace代表个别数据库服务的Schema
    maxIdle: 10                 # (可选)连接池最大闲置的连接数(默认10)
    maxOpen: 100                # (可选)连接池最大打开的连接数(默认无限制)
    maxLifetime: "30s"          # (可选)连接对象可重复使用的时间长度(默认30秒)
    queryTimeout: "0"           # (可选)查询语句超时时长(默认无限制，同时受ctx超时时间影响)。值为time.Parse支持的格式，如30s, 1m。
    execTimeout: "0"            # (可选)写入语句超时时长(默认无限制，同时受ctx超时时间影响)。值为time.Parse支持的格式，如30s, 1m。
    tranTimeout: "0"            # (可选)事务处理超时时长(默认无限制，同时受ctx超时时间影响)。值为time.Parse支持的格式，如30s, 1m。
    prepareTimeout: "0"         # (可选)预准备SQL语句执行超时时长(默认无限制，同时受ctx超时时间影响)。值为time.Parse支持的格式，如30s, 1m。
    createdAt: "created_at"     # (可选)自动创建时间字段名称
    updatedAt: "updated_at"     # (可选)自动更新时间字段名称
    deletedAt: "deleted_at"     # (可选)软删除时间字段名称
    timeMaintainDisabled: false # (可选)是否完全关闭时间更新特性，为true时CreatedAt/UpdatedAt/DeletedAt都将失效
note

使用该配置方式时， 为保证数据库安全，默认底层不支持多行 SQL 语句执行。为了得到更多配置项控制，请参考推荐的link简化配置，并了解清楚简化配置项中每个连接参数的功能作用，以及对应驱动的官方额外配置参数。

集群模式​

gdb 的配置支持集群模式，数据库配置中每一项分组配置均可以是多个节点，支持负载均衡权重策略，例如：

database:
  default:
  - link: "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
    role: "master"
  - link: "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
    role: "slave"

  user:
  - link: "mysql:root:12345678@tcp(127.0.0.1:3306)/user"
    role: "master"
  - link: "mysql:root:12345678@tcp(127.0.0.1:3306)/user"
    role: "slave"
  - link: "mysql:root:12345678@tcp(127.0.0.1:3306)/user"
    role: "slave"

以上数据库配置示例中包含两个数据库分组 default 和 user，其中 default 分组包含一主一从， user 分组包含一主两从。在代码中可以通过 g.DB() 和 g.DB("user") 获取对应的数据库连接对象。

日志配置​

gdb 支持日志输出，内部使用的是 glog.Logger 对象实现日志管理，并且可以通过配置文件对日志对象进行配置。默认情况下 gdb 关闭了 DEBUG 日志输出，如果需要打开 DEBUG 信息需要将数据库的 debug 参数设置为 true。以下是为一个配置文件示例：

database:
  logger:
    path:    "/var/log/gf-app/sql"
    level:   "all"
    stdout:  true
  default:
    link:    "mysql:root:12345678@tcp(127.0.0.1:3306)/user_center"
    debug:   true

其中 database.logger 即为 gdb 的日志配置，这是一项特殊的配置项，当该配置不存在时，将会使用日志组件的默认配置， 具体请参考 日志组件-配置管理 章节。

warning

需要注意哦：由于 ORM 底层都是采用安全的预处理执行方式，提交到底层的 SQL 与参数其实是分开的，因此日志中记录的完整 SQL 仅作参考方便人工阅读，并不是真正提交到底层的 SQL 语句。