gen

Converts a database into gorm structs and RESTful api

Github stars Tracking Chart

gen

License GoDoc travis Go Report Card

The gen tool produces golang structs from a given database for use in a .go file.
It supports gorm tags and implements some usable methods.
It can also generate RESTful api for those structs.

By reading details from the database about the column structure, gen generates a go compatible struct type
with the required column names, data types, and annotations.

Generated datatypes include support for nullable columns sql.NullX types or guregu null.X types
and the expected basic built in go types.

gen is based/inspired by the work of Seth Shelnutt's db2struct, and Db2Struct is based/inspired by the work of ChimeraCoder's gojson package gojson.

Usage

go get github.com/smallnest/gen
gen --connstr "root@tcp(127.0.0.1:3306)/employees?&parseTime=True" --database employees  --json --gorm --guregu --rest

Supported Databases

Currently Supported

  • MariaDB
  • MySQL
  • PostgreSQL
  • Microsoft SQL Server
  • SQLite

Planned Support

  • Oracle

MariaDB/MySQL

Structures are created by querying the INFORMATION_SCHEMA.Columns table and then formatting the types, column names,
and metadata to create a usable go compatible struct type.

Supported Datatypes

Currently only a limited number of datatypes are supported. Initial support includes:

  • tinyint (sql.NullInt64 or null.Int)
  • int (sql.NullInt64 or null.Int)
  • smallint (sql.NullInt64 or null.Int)
  • mediumint (sql.NullInt64 or null.Int)
  • bigint (sql.NullInt64 or null.Int)
  • decimal (sql.NullFloat64 or null.Float)
  • float (sql.NullFloat64 or null.Float)
  • double (sql.NullFloat64 or null.Float)
  • datetime (null.Time)
  • time (null.Time)
  • date (null.Time)
  • timestamp (null.Time)
  • var (sql.String or null.String)
  • enum (sql.String or null.String)
  • varchar (sql.String or null.String)
  • longtext (sql.String or null.String)
  • mediumtext (sql.String or null.String)
  • text (sql.String or null.String)
  • tinytext (sql.String or null.String)
  • binary
  • blob
  • longblob
  • mediumblob
  • varbinary

Issues

  • Postgres and SQLite driver support for sql.ColumnType.Nullable() (#3)
  • Can not distinguish primay key of tables. Only set the first field as primay key. So you need to change it in some cases.

Main metrics

Overview
Name With Ownersmallnest/gen
Primary LanguageGo
Program languageGo (Language Count: 3)
Platform
License:Apache License 2.0
所有者活动
Created At2018-03-07 10:31:36
Pushed At2023-04-24 10:18:15
Last Commit At2023-04-24 18:18:15
Release Count24
Last Release Namev0.9.29 (Posted on 2021-04-18 16:43:09)
First Release Namev0.9.0 (Posted on 2020-05-13 07:12:55)
用户参与
Stargazers Count1.4k
Watchers Count34
Fork Count232
Commits Count248
Has Issues Enabled
Issues Count103
Issue Open Count27
Pull Requests Count82
Pull Requests Open Count2
Pull Requests Close Count8
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private