├── .gitignore ├── LICENSE ├── README.md ├── main.go └── test.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 2 | *.o 3 | *.a 4 | *.so 5 | 6 | # Folders 7 | _obj 8 | _test 9 | 10 | # Architecture specific extensions/prefixes 11 | *.[568vq] 12 | [568vq].out 13 | 14 | *.cgo1.go 15 | *.cgo2.c 16 | _cgo_defun.c 17 | _cgo_gotypes.go 18 | _cgo_export.* 19 | 20 | _testmain.go 21 | 22 | *.exe 23 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | struct-create 2 | ============= 3 | 4 | Creates Go source file of structs for use in some MySQL database packages. It uses [go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) for querying the information_schema database. I created this for personal use, so it's not written for extensibility, but shouldn't be difficult to adapt for your own use. 5 | 6 | Configuration may be set in the source file: 7 | ``` 8 | var defaults = Configuration{ 9 | DbUser: "db_user", 10 | DbPassword: "db_pw", 11 | DbName: "bd_name", 12 | // PKG_NAME gives name of the package using the stucts 13 | PkgName: "DbStructs", 14 | // TAG_LABEL produces tags commonly used to match database field names with Go struct 15 | //members. This will be skipped if the string is empty. 16 | TagLabel: "db", 17 | } 18 | ``` 19 | 20 | Or by a JSON file using the json flag `struct-create --json=test.json` 21 | ``` 22 | { 23 | "db_user": "db_user", 24 | "db_password": "db_pass", 25 | "db_name": "db_name", 26 | "pkg_name": "JsonTest", 27 | "tag_label": "db" 28 | } 29 | ``` 30 | 31 | Sample output file: 32 | ``` 33 | package DbStructs 34 | 35 | import ( 36 | "time" 37 | "database/sql" 38 | ) 39 | 40 | type Audit struct{ 41 | Id int64 `db:"id"` 42 | User int64 `db:"user"` 43 | Subject string `db:"subject"` 44 | SubjectId int64 `db:"subject_id"` 45 | Action string `db:"action"` 46 | Content string `db:"content"` 47 | Created time.Time `db:"created"` 48 | } 49 | 50 | type Client struct{ 51 | Id int64 `db:"id"` 52 | Status int64 `db:"status"` 53 | Name string `db:"name"` 54 | ContactId sql.NullInt64 `db:"contact_id"` 55 | Street1 string `db:"street_1"` 56 | Street2 string `db:"street_2"` 57 | City string `db:"city"` 58 | State string `db:"state"` 59 | Zip string `db:"zip"` 60 | Phone string `db:"phone"` 61 | Fax string `db:"fax"` 62 | UpdatedAt time.Time `db:"updated_at"` 63 | CreatedAt time.Time `db:"created_at"` 64 | } 65 | 66 | type Crew struct{ 67 | Id int64 `db:"id"` 68 | Status int64 `db:"status"` 69 | TaskTypeCategoryId int64 `db:"task_type_category_id"` 70 | OfficeId int64 `db:"office_id"` 71 | LeadId int64 `db:"lead_id"` 72 | IsSubcontractor int64 `db:"is_subcontractor"` 73 | DisplayOrder int64 `db:"display_order"` 74 | WorkerCount int64 `db:"worker_count"` 75 | Name string `db:"name"` 76 | Street1 string `db:"street_1"` 77 | Street2 string `db:"street_2"` 78 | City string `db:"city"` 79 | State string `db:"state"` 80 | Zip string `db:"zip"` 81 | Phone string `db:"phone"` 82 | Cell string `db:"cell"` 83 | Fax string `db:"fax"` 84 | UpdatedAt time.Time `db:"updated_at"` 85 | CreatedAt time.Time `db:"created_at"` 86 | } 87 | 88 | type Job struct{ 89 | Id int64 `db:"id"` 90 | TractId int64 `db:"tract_id"` 91 | ClientId sql.NullInt64 `db:"client_id"` 92 | OfficeId int64 `db:"office_id"` 93 | JobHoldId int64 `db:"job_hold_id"` 94 | FieldManagerId sql.NullInt64 `db:"field_manager_id"` 95 | Lot string `db:"lot"` 96 | Name string `db:"name"` 97 | UpdatedAt time.Time `db:"updated_at"` 98 | CreatedAt time.Time `db:"created_at"` 99 | } 100 | ``` -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "database/sql" 5 | "encoding/json" 6 | "errors" 7 | "flag" 8 | "fmt" 9 | _ "github.com/go-sql-driver/mysql" 10 | "log" 11 | "os" 12 | "strings" 13 | ) 14 | 15 | var defaults = Configuration{ 16 | DbUser: "db_user", 17 | DbPassword: "db_pw", 18 | DbName: "bd_name", 19 | PkgName: "DbStructs", 20 | TagLabel: "db", 21 | } 22 | 23 | var config Configuration 24 | 25 | type Configuration struct { 26 | DbUser string `json:"db_user"` 27 | DbPassword string `json:"db_password"` 28 | DbName string `json:"db_name"` 29 | // PkgName gives name of the package using the stucts 30 | PkgName string `json:"pkg_name"` 31 | // TagLabel produces tags commonly used to match database field names with Go struct members 32 | TagLabel string `json:"tag_label"` 33 | } 34 | 35 | type ColumnSchema struct { 36 | TableName string 37 | ColumnName string 38 | IsNullable string 39 | DataType string 40 | CharacterMaximumLength sql.NullInt64 41 | NumericPrecision sql.NullInt64 42 | NumericScale sql.NullInt64 43 | ColumnType string 44 | ColumnKey string 45 | } 46 | 47 | func writeStructs(schemas []ColumnSchema) (int, error) { 48 | file, err := os.Create("db_structs.go") 49 | if err != nil { 50 | log.Fatal(err) 51 | } 52 | defer file.Close() 53 | 54 | currentTable := "" 55 | 56 | neededImports := make(map[string]bool) 57 | 58 | // First, get body text into var out 59 | out := "" 60 | for _, cs := range schemas { 61 | 62 | if cs.TableName != currentTable { 63 | if currentTable != "" { 64 | out = out + "}\n\n" 65 | } 66 | out = out + "type " + formatName(cs.TableName) + " struct{\n" 67 | } 68 | 69 | goType, requiredImport, err := goType(&cs) 70 | if requiredImport != "" { 71 | neededImports[requiredImport] = true 72 | } 73 | 74 | if err != nil { 75 | log.Fatal(err) 76 | } 77 | out = out + "\t" + formatName(cs.ColumnName) + " " + goType 78 | if len(config.TagLabel) > 0 { 79 | out = out + "\t`" + config.TagLabel + ":\"" + cs.ColumnName + "\"`" 80 | } 81 | out = out + "\n" 82 | currentTable = cs.TableName 83 | 84 | } 85 | out = out + "}" 86 | 87 | // Now add the header section 88 | header := "package " + config.PkgName + "\n\n" 89 | if len(neededImports) > 0 { 90 | header = header + "import (\n" 91 | for imp := range neededImports { 92 | header = header + "\t\"" + imp + "\"\n" 93 | } 94 | header = header + ")\n\n" 95 | } 96 | 97 | totalBytes, err := fmt.Fprint(file, header+out) 98 | if err != nil { 99 | log.Fatal(err) 100 | } 101 | return totalBytes, nil 102 | } 103 | 104 | func getSchema() []ColumnSchema { 105 | conn, err := sql.Open("mysql", config.DbUser+":"+config.DbPassword+"@/information_schema") 106 | if err != nil { 107 | log.Fatal(err) 108 | } 109 | defer conn.Close() 110 | q := "SELECT TABLE_NAME, COLUMN_NAME, IS_NULLABLE, DATA_TYPE, " + 111 | "CHARACTER_MAXIMUM_LENGTH, NUMERIC_PRECISION, NUMERIC_SCALE, COLUMN_TYPE, " + 112 | "COLUMN_KEY FROM COLUMNS WHERE TABLE_SCHEMA = ? ORDER BY TABLE_NAME, ORDINAL_POSITION" 113 | rows, err := conn.Query(q, config.DbName) 114 | if err != nil { 115 | log.Fatal(err) 116 | } 117 | columns := []ColumnSchema{} 118 | for rows.Next() { 119 | cs := ColumnSchema{} 120 | err := rows.Scan(&cs.TableName, &cs.ColumnName, &cs.IsNullable, &cs.DataType, 121 | &cs.CharacterMaximumLength, &cs.NumericPrecision, &cs.NumericScale, 122 | &cs.ColumnType, &cs.ColumnKey) 123 | if err != nil { 124 | log.Fatal(err) 125 | } 126 | columns = append(columns, cs) 127 | } 128 | if err := rows.Err(); err != nil { 129 | log.Fatal(err) 130 | } 131 | return columns 132 | } 133 | 134 | func formatName(name string) string { 135 | parts := strings.Split(name, "_") 136 | newName := "" 137 | for _, p := range parts { 138 | if len(p) < 1 { 139 | continue 140 | } 141 | newName = newName + strings.Replace(p, string(p[0]), strings.ToUpper(string(p[0])), 1) 142 | } 143 | return newName 144 | } 145 | 146 | func goType(col *ColumnSchema) (string, string, error) { 147 | requiredImport := "" 148 | if col.IsNullable == "YES" { 149 | requiredImport = "database/sql" 150 | } 151 | var gt string = "" 152 | switch col.DataType { 153 | case "char", "varchar", "enum", "set", "text", "longtext", "mediumtext", "tinytext": 154 | if col.IsNullable == "YES" { 155 | gt = "sql.NullString" 156 | } else { 157 | gt = "string" 158 | } 159 | case "blob", "mediumblob", "longblob", "varbinary", "binary": 160 | gt = "[]byte" 161 | case "date", "time", "datetime", "timestamp": 162 | gt, requiredImport = "time.Time", "time" 163 | case "bit", "tinyint", "smallint", "int", "mediumint", "bigint": 164 | if col.IsNullable == "YES" { 165 | gt = "sql.NullInt64" 166 | } else { 167 | gt = "int64" 168 | } 169 | case "float", "decimal", "double": 170 | if col.IsNullable == "YES" { 171 | gt = "sql.NullFloat64" 172 | } else { 173 | gt = "float64" 174 | } 175 | } 176 | if gt == "" { 177 | n := col.TableName + "." + col.ColumnName 178 | return "", "", errors.New("No compatible datatype (" + col.DataType + ") for " + n + " found") 179 | } 180 | return gt, requiredImport, nil 181 | } 182 | 183 | var configFile = flag.String("json", "", "Config file") 184 | 185 | func main() { 186 | flag.Parse() 187 | 188 | if len(*configFile) > 0 { 189 | f, err := os.Open(*configFile) 190 | if err != nil { 191 | log.Fatal(err) 192 | } 193 | err = json.NewDecoder(f).Decode(&config) 194 | if err != nil { 195 | log.Fatal(err) 196 | } 197 | } else { 198 | config = defaults 199 | } 200 | 201 | columns := getSchema() 202 | bytes, err := writeStructs(columns) 203 | if err != nil { 204 | log.Fatal(err) 205 | } 206 | fmt.Printf("Ok %d\n", bytes) 207 | } 208 | -------------------------------------------------------------------------------- /test.json: -------------------------------------------------------------------------------- 1 | { 2 | "db_user": "db_user", 3 | "db_password": "db_pass", 4 | "db_name": "db_name", 5 | "pkg_name": "JsonTest", 6 | "tag_label": "db" 7 | } --------------------------------------------------------------------------------