gorm-zero

A go-zero gorm extension. If you use go-zero, and you want to use GORM. You can use this extension.

Installation

• Add the dependency

go get github.com/SpectatorNan/gorm-zero

• Replace template/model in your project with gorm-zero/template/{goctl version}/model
• Generate

goctl model mysql -src={patterns} -dir={dir} -cache --home ./template

Basic Usage

Currently we support two databases: MySQL and PostgreSQL. For example:

MySQL

• Config

import (
    "github.com/SpectatorNan/gorm-zero/gormc/config/mysql"
)
type Config struct {
    Mysql mysql.Mysql
    ...
}

• Initialization

import (
    "github.com/SpectatorNan/gorm-zero/gormc/config/mysql"
)
func NewServiceContext(c config.Config) *ServiceContext {
    db, err := mysql.Connect(c.Mysql)
    if err != nil {
        log.Fatal(err)
    }
    ...
}

PostgreSQL

• Config

import (
    "github.com/SpectatorNan/gorm-zero/gormc/config/pg"
)
type Config struct {
    PgSql pg.PgSql
    ...
}

• Initialization

import (
    "github.com/SpectatorNan/gorm-zero/gormc/config/pg"
)
func NewServiceContext(c config.Config) *ServiceContext {
    db, err := pg.Connect(c.PgSql)
    if err != nil {
        log.Fatal(err)
    }
    ...
}

Quick Start

• Query with cache and custom expire duration

    gormzeroUsersIdKey := fmt.Sprintf("%s%v", cacheGormzeroUsersIdExpirePrefix, id)
    var resp Users
    err := m.QueryWithExpireCtx(ctx, &resp, gormzeroUsersIdKey, expire, func(conn *gorm.DB, v interface{}) error {
        return conn.Model(&Users{}).Where("`id` = ?", id).First(&resp).Error
    })
    switch err {
        case nil:
            return &resp, nil
        case gormc.ErrNotFound:
            return nil, ErrNotFound
        default:
            return nil, err
    }

• Query with cache and default expire duration

    gormzeroUsersIdKey := fmt.Sprintf("%s%v", cacheGormzeroUsersIdPrefix, id)
    var resp Users
    err := m.QueryCtx(ctx, &resp, gormzeroUsersIdKey, func(conn *gorm.DB, v interface{}) error {
        return conn.Model(&Users{}).Where("`id` = ?", id).First(&resp).Error
    })
    switch err {
        case nil:
            return &resp, nil
        case gormc.ErrNotFound:
            return nil, ErrNotFound
        default:
            return nil, err
    }

Examples

• go zero model example link: gorm-zero-example