Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/a631807682/ddltransform
parse ddl and transform to gorm model code
https://github.com/a631807682/ddltransform
ddl gorm mysql orm parser postgresql
Last synced: about 2 months ago
JSON representation
parse ddl and transform to gorm model code
- Host: GitHub
- URL: https://github.com/a631807682/ddltransform
- Owner: a631807682
- License: mit
- Created: 2022-06-21T12:20:05.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-01T10:58:05.000Z (12 months ago)
- Last Synced: 2024-06-21T03:16:02.765Z (3 months ago)
- Topics: ddl, gorm, mysql, orm, parser, postgresql
- Language: Go
- Homepage:
- Size: 142 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ddltransform
Parse ddl and transform to gorm model
[](https://goreportcard.com/report/github.com/a631807682/ddltransform)
[](https://github.com/a631807682/ddltransform/actions)
[](https://opensource.org/licenses/MIT)
[](https://pkg.go.dev/github.com/a631807682/ddltransform)
## Desc
Generate the orm model through parse sql to reduce the dependence on the environment
## Usage
1. Use generate model code.
```go
const ddl = `
CREATE TABLE test_data (
id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
create_at datetime NOT NULL,
deleted tinyint(1) NOT NULL,
version bigint(20) DEFAULT '10' COMMENT 'version info',
address varchar(255) NOT NULL DEFAULT 'china',
amount decimal(19,2) DEFAULT NULL,
wx_mp_app_id varchar(32) DEFAULT NULL,
contacts varchar(50) DEFAULT NULL,
PRIMARY KEY (id),
UNIQUE KEY uk_app_version (wx_mp_app_id, version)
) ENGINE=InnoDB AUTO_INCREMENT=95 DEFAULT CHARACTER SET utf8 COLLATE UTF8_GENERAL_CI ROW_FORMAT=COMPACT COMMENT='' CHECKSUM=0 DELAY_KEY_WRITE=0;
`
code, err := ddltransform.Transform(ddl, ddltransform.Config{
Parser: ddltransform.Mysql,
Transformer: ddltransform.Gorm,
})
// type TestDatum struct {
// ID uint64 `gorm:"column:id;type:bigint(20) UNSIGNED;primaryKey;autoIncrement;NOT NULL"`
// CreateAt time.Time `gorm:"column:create_at;type:datetime;NOT NULL"`
// Deleted bool `gorm:"column:deleted;type:tinyint(1);NOT NULL"`
// Version int64 `gorm:"column:version;type:bigint(20);default:10;uniqueIndex:uk_app_version;comment:version info"`
// Address string `gorm:"column:address;type:varchar(255);default:china;NOT NULL"`
// Amount float64 `gorm:"column:amount;type:decimal(19,2)"`
// WxMpAppID string `gorm:"column:wx_mp_app_id;type:varchar(32);uniqueIndex:uk_app_version"`
// Contacts string `gorm:"column:contacts;type:varchar(50)"`
// }
```
2. Customize the parser to support more db, or customize the transformer to support more code generate.
```go
type selectTransformer struct {
}
func (*selectTransformer) Name() string {
return "select_transfomer"
}
func (*selectTransformer) Transform(table string, fields []schema.Field) (modeCode string, err error) {
layout := "SELECT %s FROM %s"
cols := make([]string, len(fields))
for i, f := range fields {
cols[i] = f.DBName
}
modeCode = fmt.Sprintf(layout, strings.Join(cols, ","), table)
return
}
code, err := ddltransform.Transform(ddl, ddltransform.Config{
ParserType: ddltransform.Mysql,
Transformer: &selectTransformer{},
})
// SELECT id,create_at,deleted,version,address,amount,wx_mp_app_id,contacts FROM test_data
```
3. Use command-line to generate model code
> ddltcmd start -ps sqlite -tf gorm -p ./sql.ddl
More information about [ddltcmd](./ddltcmd/README.md)
## More Examples
See full list of [examples](./examples/)
## TODO List
#### Support Database
- [x] Mysql
- [x] Postgresql
#### Support Orm
- [x] Gorm