Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ycrao/ddl-to-object

DDL to Object
https://github.com/ycrao/ddl-to-object

curd data-type-mapper ddl generator language mysql object php script-tools sql sql-data-type

Last synced: about 9 hours ago
JSON representation

DDL to Object

Host: GitHub
URL: https://github.com/ycrao/ddl-to-object
Owner: ycrao
License: mit
Created: 2022-05-12T09:05:32.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-09-12T08:44:54.000Z (about 1 year ago)
Last Synced: 2024-06-20T05:06:21.355Z (5 months ago)
Topics: curd, data-type-mapper, ddl, generator, language, mysql, object, php, script-tools, sql, sql-data-type
Language: Go
Homepage:
Size: 66.4 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # ddl-to-object

[![GoVersion](https://img.shields.io/github/go-mod/go-version/ycrao/ddl-to-object)](https://github.com/ycrao/ddl-to-object/blob/master/go.mod)

[![Release](https://img.shields.io/github/v/release/ycrao/ddl-to-object)](https://github.com/ycrao/ddl-to-object/releases)

![Stars](https://img.shields.io/github/stars/ycrao/ddl-to-object)

[![MIT license](https://img.shields.io/github/license/ycrao/ddl-to-object)](https://opensource.org/licenses/MIT)

[![OpenIssue](https://img.shields.io/github/issues/ycrao/ddl-to-object)](https://github.com/ycrao/ddl-to-object/issues?q=is%3Aopen+is%3Aissue)

[SimplifiedChinese README/简体中文读我](./README_zh-CN.md)

>   ddl-to-object: a tool help to generate object files in different languages from sql ddl file.

### database supports

- only tested for MySQL/MariaDB DDL SQL

### language supports

>   PR is welcome! You can do some coding stuff to support another language.

- java: generate entity class with auto snake_style to camelStyle naming in properties, bring comments, using lombok plugin for getter/setter, with package directory support

- golang: generate to struct with tags and comments

- php: generate to simple class with namespace and comments support

- python: generate to simple object with comments support

- support any other program language?: pull request is welcome

### best practice

- A good-designed pattern in MySQL DDL, such as using singular nouns as table and column name, naming in `snake_case` style, with more comments, no table prefix, having a primary key etc.

- The rest, just using this tool to help you generate target language object files

#### installation

Download targeted OS zip file, unzip it, and move the binary file (`ddl-to-object` or `ddl-to-object.exe`) to `/usr/local/bin/` or other auto-load environment path. 

By default, you need copy this project template files into to `~/.dto/template` directory manually (note: `~` for current user home workdir).

Then you run it in terminal from anywhere. Get helps from its help print or below.

#### command helps

```bash

  ddl-to-object go         generate golang target object file

  ddl-to-object java       generate java target object file

  ddl-to-object php        generate php target object file

  ddl-to-object python     generate python target object file

  -f, --from path      from path which a single-table DDL file located

  -n, --ns namespace   namespace name for php, only in php command (default "App\\Models")

  -p, --pk package     package name, only in java or go command (default "com.example.sample.domain.entity")

  -s, --stdout         enable stdout or not, default set false to disable

  -t, --to path        output to target path or location, create directory automatically if it not existed

```

#### usage examples

```bash

$ ddl-to-object php -f ./output/samples/example_3.ddl.txt -n Modules\\Blog\\Models -t ./output/php/

$ ddl-to-object java -f ./output/samples/example_2.ddl.txt -p com.douyasi.sample.domain.entity -t ./output/java/

$ ddl-to-object go -f ./output/sampls/example_3.ddl.txt -p models -t ./output/go/

```

#### output examples

See output directory.

- [java](./output/java/Article.java)

- [golang](./output/go/article_types.go)

- [php](./output/php/Article.php)

- [python](./output/python/article.py)

#### how to modify templates

As installation intro, default template files located in `~/.dto/template` directory (note: `~` for current user home workdir; if they're not existed, you need copy them by yourself manually) .

The template is a raw text by using golang [text/template](https://pkg.go.dev/text/template) with `ParsedResult` type struct passed in. You can modify them as you can. 

### known so-called bugs

- not work well in one-line DDL SQL

- not work well with mixed style (such as snake_style, camelStyle, PascalStyle and other cases mixed) in DDL SQL

- special table or field name, such as `365Days_table`, `1st_field` and `biz.error.code.field` etc 

- some MySQL data type may not mapper well to Java or Golang data type

- some unused imports in Java and Golang, you can clean them by yourself or using some tool like `gofmt`

- lack of some special testing cases

### similar projects and references

- [liangyaopei/sqltogo](https://github.com/liangyaopei/sqltogo)

- [xwb1989/sqlparser](https://github.com/xwb1989/sqlparser)

- [nao1215/ddl-maker](https://github.com/nao1215/ddl-maker)

- [zeromicro/ddl-parser](https://github.com/zeromicro/ddl-parser)

- [blastrain/vitess-sqlparser](https://github.com/blastrain/vitess-sqlparser)

- [json-to-go](https://mholt.github.io/json-to-go/)

- [curl-to-go](https://mholt.github.io/curl-to-go/)

- [sql-to-go-struct-java-class-json-format](https://plugins.jetbrains.com/plugin/17336-sql-to-go-struct-java-class-json-format)