mysql code generation

Overview

mysql code generation support is generated from sql files and database links and supports generating a cache logic code.

mysql generated code content with golang structure corresponding to the data table, CURD operation methods, cache logic, etc. More detailed database code generated reference goctl model

Task Targets

  1. familiar with goctl generating mysql code use commands to learn about currently supported instructions and features
  2. Preliminary understanding of the format of goctl generating mysql code
  3. Preliminary master build process from sql file to mysql code

Preparing

  1. Complete golang installation
  2. Complete goctl installation

Code Generation

  1. Execute the following instructions to store sample sql files in local user.sql.

    1. CREATE TABLE user (
    2.     id bigint AUTO_INCREMENT,
    3.     name varchar(255) NULL COMMENT 'The username',
    4.     password varchar(255) NOT NULL DEFAULT '' COMMENT 'The user password',
    5.     mobile varchar(255) NOT NULL DEFAULT '' COMMENT 'The mobile phone number',
    6.     gender char(10) NOT NULL DEFAULT 'male' COMMENT 'gender,male|female|unknown',
    7.     nickname varchar(255) NULL DEFAULT '' COMMENT 'The nickname',
    8.     type tinyint(1) NULL DEFAULT 0 COMMENT 'The user type, 0:normal,1:vip, for test golang keyword',
    9.     create_at timestamp NULL,
    10.     update_at timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    11.     UNIQUE mobile_index (mobile),
    12.     UNIQUE name_index (name),
    13.     PRIMARY KEY (id)
    14. ) ENGINE = InnoDB COLLATE utf8mb4_general_ci COMMENT 'user table';

  2. Create workspace and directory

    1. $ mkdir -p ~/workspace/model/mysql

  3. Move the user.sql file stored above to ~/workspace/model/mysql directory

  4. Generate model code

    1. $ cd ~/workspace/model/mysql
    2. $ goctl model mysql ddl --src user.sql --dir .
    3. Done.

    When you see Done. output is generated successfully, then we see the code content generated：

    1. # list files in current directory
    2. $ ls
    3. user.sql         usermodel.go     usermodel_gen.go vars.go
    4. # view directory tree
    5. $ tree
    6. .
    7. ├── user.sql
    8. ├── usermodel.go
    9. ├── usermodel_gen.go
    10. └── vars.go
    12. 0 directories, 4 files

  5. Code View

    • user.sql
    • usermodel.go
    • usermodel_gen.go
    • vars.go
    1. CREATE TABLE user (
    2.     id bigint AUTO_INCREMENT,
    3.     name varchar(255) NULL COMMENT 'The username',
    4.     password varchar(255) NOT NULL DEFAULT '' COMMENT 'The user password',
    5.     mobile varchar(255) NOT NULL DEFAULT '' COMMENT 'The mobile phone number',
    6.     gender char(10) NOT NULL DEFAULT 'male' COMMENT 'gender,male|female|unknown',
    7.     nickname varchar(255) NULL DEFAULT '' COMMENT 'The nickname',
    8.     type tinyint(1) NULL DEFAULT 0 COMMENT 'The user type, 0:normal,1:vip, for test golang keyword',
    9.     create_at timestamp NULL,
    10.     update_at timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    11.     UNIQUE mobile_index (mobile),
    12.     UNIQUE name_index (name),
    13.     PRIMARY KEY (id)
    14. ) ENGINE = InnoDB COLLATE utf8mb4_general_ci COMMENT 'user table';
    1. package mysql
    3. import "github.com/zeromicro/go-zero/core/stores/sqlx"
    5. var _ UserModel = (*customUserModel)(nil)
    7. type (
    8.     // UserModel is an interface to be customized, add more methods here,
    9.     // and implement the added methods in customUserModel.
    10.     UserModel interface {
    11.         userModel
    12.     }
    14.     customUserModel struct {
    15.         *defaultUserModel
    16.     }
    17. )
    19. // NewUserModel returns a model for the database table.
    20. func NewUserModel(conn sqlx.SqlConn) UserModel {
    21.     return &customUserModel{
    22.         defaultUserModel: newUserModel(conn),
    23.     }
    24. }
    1. // Code generated by goctl. DO NOT EDIT.
    3. package mysql
    5. import (
    6.     "context"
    7.     "database/sql"
    8.     "fmt"
    9.     "strings"
    10.     "time"
    12.     "github.com/zeromicro/go-zero/core/stores/builder"
    13.     "github.com/zeromicro/go-zero/core/stores/sqlc"
    14.     "github.com/zeromicro/go-zero/core/stores/sqlx"
    15.     "github.com/zeromicro/go-zero/core/stringx"
    16. )
    18. var (
    19.     userFieldNames          = builder.RawFieldNames(&User{})
    20.     userRows                = strings.Join(userFieldNames, ",")
    21.     userRowsExpectAutoSet   = strings.Join(stringx.Remove(userFieldNames, "`id`", "`update_time`", "`create_at`", "`created_at`", "`create_time`", "`update_at`", "`updated_at`"), ",")
    22.     userRowsWithPlaceHolder = strings.Join(stringx.Remove(userFieldNames, "`id`", "`update_time`", "`create_at`", "`created_at`", "`create_time`", "`update_at`", "`updated_at`"), "=?,") + "=?"
    23. )
    25. type (
    26.     userModel interface {
    27.         Insert(ctx context.Context, data *User) (sql.Result, error)
    28.         FindOne(ctx context.Context, id int64) (*User, error)
    29.         FindOneByMobile(ctx context.Context, mobile string) (*User, error)
    30.         FindOneByName(ctx context.Context, name sql.NullString) (*User, error)
    31.         Update(ctx context.Context, data *User) error
    32.         Delete(ctx context.Context, id int64) error
    33.     }
    35.     defaultUserModel struct {
    36.         conn  sqlx.SqlConn
    37.         table string
    38.     }
    40.     User struct {
    41.         Id       int64          `db:"id"`
    42.         Name     sql.NullString `db:"name"`     // The username
    43.         Password string         `db:"password"` // The user password
    44.         Mobile   string         `db:"mobile"`   // The mobile phone number
    45.         Gender   string         `db:"gender"`   // gender,male|female|unknown
    46.         Nickname string         `db:"nickname"` // The nickname
    47.         Type     int64          `db:"type"`     // The user type, 0:normal,1:vip, for test golang keyword
    48.         CreateAt sql.NullTime   `db:"create_at"`
    49.         UpdateAt time.Time      `db:"update_at"`
    50.     }
    51. )
    53. func newUserModel(conn sqlx.SqlConn) *defaultUserModel {
    54.     return &defaultUserModel{
    55.         conn:  conn,
    56.         table: "`user`",
    57.     }
    58. }
    60. func (m *defaultUserModel) Delete(ctx context.Context, id int64) error {
    61.     query := fmt.Sprintf("delete from %s where `id` = ?", m.table)
    62.     _, err := m.conn.ExecCtx(ctx, query, id)
    63.     return err
    64. }
    66. func (m *defaultUserModel) FindOne(ctx context.Context, id int64) (*User, error) {
    67.     query := fmt.Sprintf("select %s from %s where `id` = ? limit 1", userRows, m.table)
    68.     var resp User
    69.     err := m.conn.QueryRowCtx(ctx, &resp, query, id)
    70.     switch err {
    71.     case nil:
    72.         return &resp, nil
    73.     case sqlc.ErrNotFound:
    74.         return nil, ErrNotFound
    75.     default:
    76.         return nil, err
    77.     }
    78. }
    80. func (m *defaultUserModel) FindOneByMobile(ctx context.Context, mobile string) (*User, error) {
    81.     var resp User
    82.     query := fmt.Sprintf("select %s from %s where `mobile` = ? limit 1", userRows, m.table)
    83.     err := m.conn.QueryRowCtx(ctx, &resp, query, mobile)
    84.     switch err {
    85.     case nil:
    86.         return &resp, nil
    87.     case sqlc.ErrNotFound:
    88.         return nil, ErrNotFound
    89.     default:
    90.         return nil, err
    91.     }
    92. }
    94. func (m *defaultUserModel) FindOneByName(ctx context.Context, name sql.NullString) (*User, error) {
    95.     var resp User
    96.     query := fmt.Sprintf("select %s from %s where `name` = ? limit 1", userRows, m.table)
    97.     err := m.conn.QueryRowCtx(ctx, &resp, query, name)
    98.     switch err {
    99.     case nil:
    100.         return &resp, nil
    101.     case sqlc.ErrNotFound:
    102.         return nil, ErrNotFound
    103.     default:
    104.         return nil, err
    105.     }
    106. }
    108. func (m *defaultUserModel) Insert(ctx context.Context, data *User) (sql.Result, error) {
    109.     query := fmt.Sprintf("insert into %s (%s) values (?, ?, ?, ?, ?, ?)", m.table, userRowsExpectAutoSet)
    110.     ret, err := m.conn.ExecCtx(ctx, query, data.Name, data.Password, data.Mobile, data.Gender, data.Nickname, data.Type)
    111.     return ret, err
    112. }
    114. func (m *defaultUserModel) Update(ctx context.Context, newData *User) error {
    115.     query := fmt.Sprintf("update %s set %s where `id` = ?", m.table, userRowsWithPlaceHolder)
    116.     _, err := m.conn.ExecCtx(ctx, query, newData.Name, newData.Password, newData.Mobile, newData.Gender, newData.Nickname, newData.Type, newData.Id)
    117.     return err
    118. }
    120. func (m *defaultUserModel) tableName() string {
    121.     return m.table
    122. }
    1. package mysql
    3. import "github.com/zeromicro/go-zero/core/stores/sqlx"
    5. var ErrNotFound = sqlx.ErrNotFound