├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── cmd └── db2struct │ └── main.go ├── go.mod ├── go.sum ├── tests └── mariadb.sql ├── utils.go ├── utils_mysql.go ├── utils_mysql_test.go └── utils_test.go /.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 | *.test 24 | *.prof 25 | .idea/ 26 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: go 2 | addons: 3 | mariadb: '10.3' 4 | go: 5 | - tip 6 | before_install: 7 | - go get github.com/mattn/goveralls 8 | - go get golang.org/x/tools/cmd/cover 9 | - mysql < tests/mariadb.sql 10 | script: 11 | - $HOME/gopath/bin/goveralls -service=travis-ci 12 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # db2struct [![Build Status](https://travis-ci.org/Shelnutt2/db2struct.svg?branch=master)](https://travis-ci.org/Shelnutt2/db2struct) [![Coverage Status](https://coveralls.io/repos/github/Shelnutt2/db2struct/badge.svg?branch=1-add-coveralls-support)](https://coveralls.io/github/Shelnutt2/db2struct?branch=1-add-coveralls-support) [![GoDoc](https://godoc.org/github.com/Shelnutt2/db2struct?status.svg)](https://godoc.org/github.com/Shelnutt2/db2struct) 2 | 3 | The db2struct package produces a usable golang struct from a given database table for use in a .go file. 4 | 5 | By reading details from the database about the column structure, db2struct generates a go compatible struct type 6 | with the required column names, data types, and annotations. 7 | 8 | Generated datatypes include support for nullable columns [sql.NullX types](https://golang.org/pkg/database/sql/#NullBool) or [guregu null.X types](https://github.com/guregu/null) 9 | and the expected basic built in go types. 10 | 11 | Db2Struct is based/inspired by the work of ChimeraCoder's gojson package 12 | [gojson](https://github.com/ChimeraCoder/gojson) 13 | 14 | 15 | 16 | ## Usage 17 | 18 | ```BASH 19 | go get github.com/Shelnutt2/db2struct/cmd/db2struct 20 | db2struct --host localhost -d test -t test_table --package myGoPackage --struct testTable -p --user testUser 21 | ``` 22 | 23 | ## Example 24 | 25 | MySQL table named users with four columns: id (int), user_name (varchar(255)), number_of_logins (int(11),nullable), and LAST_NAME (varchar(255), nullable) 26 | 27 | Example below uses guregu's null package, but without the option it procuded the sql.NullInt64 and so on. 28 | ```BASH 29 | db2struct --host localhost -d example.com -t users --package example --struct user -p --user exampleUser --guregu --gorm 30 | ``` 31 | 32 | Output: 33 | ```GOLANG 34 | 35 | package example 36 | 37 | type User struct { 38 | ID int `gorm:"column:id"` 39 | UserName string `gorm:"column:user_name"` 40 | NumberOfLogins null.Int `gorm:"column:number_of_logins"` 41 | LastName null.String `gorm:"column:LAST_NAME"` 42 | } 43 | ``` 44 | 45 | ## Supported Databases 46 | 47 | Currently Supported 48 | - MariaDB 49 | - MySQL 50 | 51 | Planned Support 52 | - PostgreSQL 53 | - Oracle 54 | - Microsoft SQL Server 55 | 56 | ### MariaDB/MySQL 57 | 58 | Structures are created by querying the INFORMATION_SCHEMA.Columns table and then formatting the types, column names, 59 | and metadata to create a usable go compatible struct type. 60 | 61 | NOTE: If you wish to use a unix socket instead of a TCP socket, 62 | specify the hostname as `unix:` then the path to the named socket. 63 | For example: 64 | 65 | ```BASH 66 | --host unix:/tmp/mysql.sock 67 | ``` 68 | 69 | #### Supported Datatypes 70 | 71 | Currently only a limited number of MariaDB/MySQL datatypes are supported. Initial support includes: 72 | - tinyint (sql.NullInt64 or null.Int) 73 | - int (sql.NullInt64 or null.Int) 74 | - smallint (sql.NullInt64 or null.Int) 75 | - mediumint (sql.NullInt64 or null.Int) 76 | - bigint (sql.NullInt64 or null.Int) 77 | - decimal (sql.NullFloat64 or null.Float) 78 | - float (sql.NullFloat64 or null.Float) 79 | - double (sql.NullFloat64 or null.Float) 80 | - datetime (null.Time) 81 | - time (null.Time) 82 | - date (null.Time) 83 | - timestamp (null.Time) 84 | - var (sql.String or null.String) 85 | - enum (sql.String or null.String) 86 | - varchar (sql.String or null.String) 87 | - longtext (sql.String or null.String) 88 | - mediumtext (sql.String or null.String) 89 | - text (sql.String or null.String) 90 | - tinytext (sql.String or null.String) 91 | - binary 92 | - blob 93 | - longblob 94 | - mediumblob 95 | - varbinary 96 | - json 97 | -------------------------------------------------------------------------------- /cmd/db2struct/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | "strconv" 7 | 8 | "github.com/Shelnutt2/db2struct" 9 | goopt "github.com/droundy/goopt" 10 | _ "github.com/go-sql-driver/mysql" 11 | "github.com/howeyc/gopass" 12 | ) 13 | 14 | var mariadbHost = os.Getenv("MYSQL_HOST") 15 | var mariadbHostPassed = goopt.String([]string{"-H", "--host"}, "", "Host to check mariadb status of") 16 | var mariadbPort = goopt.Int([]string{"--mysql_port"}, 3306, "Specify a port to connect to") 17 | var mariadbTable = goopt.String([]string{"-t", "--table"}, "", "Table to build struct from") 18 | var mariadbDatabase = goopt.String([]string{"-d", "--database"}, "nil", "Database to for connection") 19 | var mariadbPassword *string 20 | var mariadbUser = goopt.String([]string{"-u", "--user"}, "user", "user to connect to database") 21 | var verbose = goopt.Flag([]string{"-v", "--verbose"}, []string{}, "Enable verbose output", "") 22 | var packageName = goopt.String([]string{"--package"}, "", "name to set for package") 23 | var structName = goopt.String([]string{"--struct"}, "", "name to set for struct") 24 | 25 | var jsonAnnotation = goopt.Flag([]string{"--json"}, []string{"--no-json"}, "Add json annotations (default)", "Disable json annotations") 26 | var gormAnnotation = goopt.Flag([]string{"--gorm"}, []string{}, "Add gorm annotations (tags)", "") 27 | var gureguTypes = goopt.Flag([]string{"--guregu"}, []string{}, "Add guregu null types", "") 28 | var targetFile = goopt.String([]string{"--target"}, "", "Save file path") 29 | 30 | func init() { 31 | goopt.OptArg([]string{"-p", "--password"}, "", "Mysql password", getMariadbPassword) 32 | //goopt.ReqArg([]string{"-u", "--user"}, "user", "user to connect to database", setUser) 33 | 34 | // Setup goopts 35 | goopt.Description = func() string { 36 | return "Mariadb http Check" 37 | } 38 | goopt.Version = "0.0.2" 39 | goopt.Summary = "db2struct [-H] [-p] [-v] --package pkgName --struct structName --database databaseName --table tableName" 40 | 41 | //Parse options 42 | goopt.Parse(nil) 43 | 44 | } 45 | 46 | func main() { 47 | 48 | // Username is required 49 | if mariadbUser == nil || *mariadbUser == "user" { 50 | fmt.Println("Username is required! Add it with --user=name") 51 | return 52 | } 53 | 54 | // If a mariadb host is passed use it 55 | if mariadbHostPassed != nil && *mariadbHostPassed != "" { 56 | mariadbHost = *mariadbHostPassed 57 | } 58 | 59 | if mariadbPassword != nil && *mariadbPassword == "" { 60 | fmt.Print("Password: ") 61 | pass, err := gopass.GetPasswd() 62 | stringPass := string(pass) 63 | mariadbPassword = &stringPass 64 | if err != nil { 65 | fmt.Println("Error reading password: " + err.Error()) 66 | return 67 | } 68 | } else if mariadbPassword == nil { 69 | p := "" 70 | mariadbPassword = &p 71 | } 72 | 73 | if *verbose { 74 | fmt.Println("Connecting to mysql server " + mariadbHost + ":" + strconv.Itoa(*mariadbPort)) 75 | } 76 | 77 | if mariadbDatabase == nil || *mariadbDatabase == "" { 78 | fmt.Println("Database can not be null") 79 | return 80 | } 81 | 82 | if mariadbTable == nil || *mariadbTable == "" { 83 | fmt.Println("Table can not be null") 84 | return 85 | } 86 | 87 | columnDataTypes, columnsSorted, err := db2struct.GetColumnsFromMysqlTable(*mariadbUser, *mariadbPassword, mariadbHost, *mariadbPort, *mariadbDatabase, *mariadbTable) 88 | 89 | if err != nil { 90 | fmt.Println("Error in selecting column data information from mysql information schema") 91 | return 92 | } 93 | 94 | // If structName is not set we need to default it 95 | if structName == nil || *structName == "" { 96 | *structName = "newstruct" 97 | } 98 | // If packageName is not set we need to default it 99 | if packageName == nil || *packageName == "" { 100 | *packageName = "newpackage" 101 | } 102 | // Generate struct string based on columnDataTypes 103 | struc, err := db2struct.Generate(*columnDataTypes, columnsSorted, *mariadbTable, *structName, *packageName, *jsonAnnotation, *gormAnnotation, *gureguTypes) 104 | 105 | if err != nil { 106 | fmt.Println("Error in creating struct from json: " + err.Error()) 107 | return 108 | } 109 | if targetFile != nil && *targetFile != "" { 110 | file, err := os.OpenFile(*targetFile, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) 111 | if err != nil { 112 | fmt.Println("Open File fail: " + err.Error()) 113 | return 114 | } 115 | length, err := file.WriteString(string(struc)) 116 | if err != nil { 117 | fmt.Println("Save File fail: " + err.Error()) 118 | return 119 | } 120 | fmt.Printf("wrote %d bytes\n", length) 121 | } else { 122 | fmt.Println(string(struc)) 123 | } 124 | } 125 | 126 | func getMariadbPassword(password string) error { 127 | mariadbPassword = new(string) 128 | *mariadbPassword = password 129 | return nil 130 | } 131 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/Shelnutt2/db2struct 2 | 3 | go 1.12 4 | 5 | require ( 6 | github.com/droundy/goopt v0.0.0-20170604162106-0b8effe182da 7 | github.com/go-sql-driver/mysql v1.4.1 8 | github.com/howeyc/gopass v0.0.0-20170109162249-bf9dde6d0d2c 9 | github.com/smartystreets/goconvey v1.7.2 10 | golang.org/x/crypto v0.1.0 // indirect 11 | google.golang.org/appengine v1.6.7 // indirect 12 | ) 13 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/droundy/goopt v0.0.0-20170604162106-0b8effe182da h1:79H+mNJWOObWrQgbkSvvZ3t/D2lKWaTi9mu/v7fNRvg= 2 | github.com/droundy/goopt v0.0.0-20170604162106-0b8effe182da/go.mod h1:ytRJ64WkuW4kf6/tuYqBATBCRFUP8X9+LDtgcvE+koI= 3 | github.com/go-sql-driver/mysql v1.4.1 h1:g24URVg0OFbNUTx9qqY1IRZ9D9z3iPyi5zKhQZpNwpA= 4 | github.com/go-sql-driver/mysql v1.4.1/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w= 5 | github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= 6 | github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGaHF6qqu48+N2wcFQ5qg5FXgOdqsJ5d8= 7 | github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= 8 | github.com/howeyc/gopass v0.0.0-20170109162249-bf9dde6d0d2c h1:kQWxfPIHVLbgLzphqk3QUflDy9QdksZR4ygR807bpy0= 9 | github.com/howeyc/gopass v0.0.0-20170109162249-bf9dde6d0d2c/go.mod h1:lADxMC39cJJqL93Duh1xhAs4I2Zs8mKS89XWXFGp9cs= 10 | github.com/jtolds/gls v4.20.0+incompatible h1:xdiiI2gbIgH/gLH7ADydsJ1uDOEzR8yvV7C0MuV77Wo= 11 | github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= 12 | github.com/smartystreets/assertions v1.2.0 h1:42S6lae5dvLc7BrLu/0ugRtcFVjoJNMC/N3yZFZkDFs= 13 | github.com/smartystreets/assertions v1.2.0/go.mod h1:tcbTF8ujkAEcZ8TElKY+i30BzYlVhC/LOxJk7iOWnoo= 14 | github.com/smartystreets/goconvey v1.7.2 h1:9RBaZCeXEQ3UselpuwUQHltGVXvdwm6cv1hgR6gDIPg= 15 | github.com/smartystreets/goconvey v1.7.2/go.mod h1:Vw0tHAZW6lzCRk3xgdin6fKYcG+G3Pg9vgXWeJpQFMM= 16 | github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= 17 | golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= 18 | golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= 19 | golang.org/x/crypto v0.1.0 h1:MDRAIl0xIo9Io2xV565hzXHw3zVseKrJKodhohM5CjU= 20 | golang.org/x/crypto v0.1.0/go.mod h1:RecgLatLF4+eUMCP1PoPZQb+cVrJcOPbHkTkbkB9sbw= 21 | golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= 22 | golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= 23 | golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= 24 | golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= 25 | golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= 26 | golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= 27 | golang.org/x/net v0.1.0/go.mod h1:Cx3nUiGt4eDBEyega/BKRp+/AlGL8hYe7U9odMt2Cco= 28 | golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 29 | golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 30 | golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= 31 | golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 32 | golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 33 | golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 34 | golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 35 | golang.org/x/sys v0.1.0 h1:kunALQeHf1/185U1i0GOB/fy1IPRDDpuoOOqRReG57U= 36 | golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 37 | golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= 38 | golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= 39 | golang.org/x/term v0.1.0 h1:g6Z6vPFA9dYBAF7DWcH6sCcOntplXsDKcliusYijMlw= 40 | golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= 41 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 42 | golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= 43 | golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= 44 | golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= 45 | golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= 46 | golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= 47 | golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= 48 | golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= 49 | golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= 50 | golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= 51 | google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c= 52 | google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= 53 | -------------------------------------------------------------------------------- /tests/mariadb.sql: -------------------------------------------------------------------------------- 1 | CREATE DATABASE IF NOT EXISTS test; 2 | DROP TABLE IF EXISTS test.`all_data_types`; 3 | CREATE TABLE test.`all_data_types` ( 4 | `varchar` VARCHAR( 20 ) NOT NULL , 5 | `tinyint` TINYINT NOT NULL , 6 | `text` TEXT NOT NULL , 7 | `date` DATE NOT NULL , 8 | `smallint` SMALLINT NOT NULL , 9 | `mediumint` MEDIUMINT NOT NULL , 10 | `int` INT NOT NULL , 11 | `bigint` BIGINT NOT NULL , 12 | `float` FLOAT( 10, 2 ) NOT NULL , 13 | `double` DOUBLE NOT NULL , 14 | `decimal` DECIMAL( 10, 2 ) NOT NULL , 15 | `datetime` DATETIME NOT NULL , 16 | `timestamp` TIMESTAMP NOT NULL , 17 | `time` TIME NOT NULL , 18 | `year` YEAR NOT NULL , 19 | `char` CHAR( 10 ) NOT NULL , 20 | `tinyblob` TINYBLOB NOT NULL , 21 | `tinytext` TINYTEXT NOT NULL , 22 | `blob` BLOB NOT NULL , 23 | `mediumblob` MEDIUMBLOB NOT NULL , 24 | `mediumtext` MEDIUMTEXT NOT NULL , 25 | `longblob` LONGBLOB NOT NULL , 26 | `longtext` LONGTEXT NOT NULL , 27 | `enum` ENUM( '1', '2', '3' ) NOT NULL , 28 | `set` SET( '1', '2', '3' ) NOT NULL , 29 | `bool` BOOL NOT NULL , 30 | `binary` BINARY( 20 ) NOT NULL , 31 | `varbinary` VARBINARY( 20 ) NOT NULL 32 | ); 33 | -------------------------------------------------------------------------------- /utils.go: -------------------------------------------------------------------------------- 1 | package db2struct 2 | 3 | import ( 4 | "fmt" 5 | "go/format" 6 | "strconv" 7 | "strings" 8 | "unicode" 9 | ) 10 | 11 | // Constants for return types of golang 12 | const ( 13 | golangByteArray = "[]byte" 14 | gureguNullInt = "null.Int" 15 | sqlNullInt = "sql.NullInt64" 16 | golangInt = "int" 17 | golangInt64 = "int64" 18 | gureguNullFloat = "null.Float" 19 | sqlNullFloat = "sql.NullFloat64" 20 | golangFloat = "float" 21 | golangFloat32 = "float32" 22 | golangFloat64 = "float64" 23 | gureguNullString = "null.String" 24 | sqlNullString = "sql.NullString" 25 | gureguNullTime = "null.Time" 26 | golangTime = "time.Time" 27 | ) 28 | 29 | // commonInitialisms is a set of common initialisms. 30 | // Only add entries that are highly unlikely to be non-initialisms. 31 | // For instance, "ID" is fine (Freudian code is rare), but "AND" is not. 32 | var commonInitialisms = map[string]bool{ 33 | "API": true, 34 | "ASCII": true, 35 | "CPU": true, 36 | "CSS": true, 37 | "DNS": true, 38 | "EOF": true, 39 | "GUID": true, 40 | "HTML": true, 41 | "HTTP": true, 42 | "HTTPS": true, 43 | "ID": true, 44 | "IP": true, 45 | "JSON": true, 46 | "LHS": true, 47 | "QPS": true, 48 | "RAM": true, 49 | "RHS": true, 50 | "RPC": true, 51 | "SLA": true, 52 | "SMTP": true, 53 | "SSH": true, 54 | "TLS": true, 55 | "TTL": true, 56 | "UI": true, 57 | "UID": true, 58 | "UUID": true, 59 | "URI": true, 60 | "URL": true, 61 | "UTF8": true, 62 | "VM": true, 63 | "XML": true, 64 | } 65 | 66 | var intToWordMap = []string{ 67 | "zero", 68 | "one", 69 | "two", 70 | "three", 71 | "four", 72 | "five", 73 | "six", 74 | "seven", 75 | "eight", 76 | "nine", 77 | } 78 | 79 | //Debug level logging 80 | var Debug = false 81 | 82 | // Generate Given a Column map with datatypes and a name structName, 83 | // attempts to generate a struct definition 84 | func Generate(columnTypes map[string]map[string]string, columnsSorted []string, tableName string, structName string, pkgName string, jsonAnnotation bool, gormAnnotation bool, gureguTypes bool) ([]byte, error) { 85 | var dbTypes string 86 | dbTypes = generateMysqlTypes(columnTypes, columnsSorted, 0, jsonAnnotation, gormAnnotation, gureguTypes) 87 | src := fmt.Sprintf("package %s\ntype %s %s\n}", 88 | pkgName, 89 | structName, 90 | dbTypes) 91 | if gormAnnotation == true { 92 | tableNameFunc := "// TableName sets the insert table name for this struct type\n" + 93 | "func (" + strings.ToLower(string(structName[0])) + " *" + structName + ") TableName() string {\n" + 94 | " return \"" + tableName + "\"" + 95 | "}" 96 | src = fmt.Sprintf("%s\n%s", src, tableNameFunc) 97 | } 98 | formatted, err := format.Source([]byte(src)) 99 | if err != nil { 100 | err = fmt.Errorf("error formatting: %s, was formatting\n%s", err, src) 101 | } 102 | return formatted, err 103 | } 104 | 105 | // fmtFieldName formats a string as a struct key 106 | // 107 | // Example: 108 | // fmtFieldName("foo_id") 109 | // Output: FooID 110 | func fmtFieldName(s string) string { 111 | name := lintFieldName(s) 112 | runes := []rune(name) 113 | for i, c := range runes { 114 | ok := unicode.IsLetter(c) || unicode.IsDigit(c) 115 | if i == 0 { 116 | ok = unicode.IsLetter(c) 117 | } 118 | if !ok { 119 | runes[i] = '_' 120 | } 121 | } 122 | return string(runes) 123 | } 124 | 125 | func lintFieldName(name string) string { 126 | // Fast path for simple cases: "_" and all lowercase. 127 | if name == "_" { 128 | return name 129 | } 130 | 131 | for len(name) > 0 && name[0] == '_' { 132 | name = name[1:] 133 | } 134 | 135 | allLower := true 136 | for _, r := range name { 137 | if !unicode.IsLower(r) { 138 | allLower = false 139 | break 140 | } 141 | } 142 | if allLower { 143 | runes := []rune(name) 144 | if u := strings.ToUpper(name); commonInitialisms[u] { 145 | copy(runes[0:], []rune(u)) 146 | } else { 147 | runes[0] = unicode.ToUpper(runes[0]) 148 | } 149 | return string(runes) 150 | } 151 | 152 | // Split camelCase at any lower->upper transition, and split on underscores. 153 | // Check each word for common initialisms. 154 | runes := []rune(name) 155 | w, i := 0, 0 // index of start of word, scan 156 | for i+1 <= len(runes) { 157 | eow := false // whether we hit the end of a word 158 | 159 | if i+1 == len(runes) { 160 | eow = true 161 | } else if runes[i+1] == '_' { 162 | // underscore; shift the remainder forward over any run of underscores 163 | eow = true 164 | n := 1 165 | for i+n+1 < len(runes) && runes[i+n+1] == '_' { 166 | n++ 167 | } 168 | 169 | // Leave at most one underscore if the underscore is between two digits 170 | if i+n+1 < len(runes) && unicode.IsDigit(runes[i]) && unicode.IsDigit(runes[i+n+1]) { 171 | n-- 172 | } 173 | 174 | copy(runes[i+1:], runes[i+n+1:]) 175 | runes = runes[:len(runes)-n] 176 | } else if unicode.IsLower(runes[i]) && !unicode.IsLower(runes[i+1]) { 177 | // lower->non-lower 178 | eow = true 179 | } 180 | i++ 181 | if !eow { 182 | continue 183 | } 184 | 185 | // [w,i) is a word. 186 | word := string(runes[w:i]) 187 | if u := strings.ToUpper(word); commonInitialisms[u] { 188 | // All the common initialisms are ASCII, 189 | // so we can replace the bytes exactly. 190 | copy(runes[w:], []rune(u)) 191 | 192 | } else if strings.ToLower(word) == word { 193 | // already all lowercase, and not the first word, so uppercase the first character. 194 | runes[w] = unicode.ToUpper(runes[w]) 195 | } 196 | w = i 197 | } 198 | return string(runes) 199 | } 200 | 201 | // convert first character ints to strings 202 | func stringifyFirstChar(str string) string { 203 | first := str[:1] 204 | 205 | i, err := strconv.ParseInt(first, 10, 8) 206 | 207 | if err != nil { 208 | return str 209 | } 210 | 211 | return intToWordMap[i] + "_" + str[1:] 212 | } 213 | -------------------------------------------------------------------------------- /utils_mysql.go: -------------------------------------------------------------------------------- 1 | package db2struct 2 | 3 | import ( 4 | "database/sql" 5 | "errors" 6 | "fmt" 7 | "strconv" 8 | "strings" 9 | ) 10 | 11 | // GetColumnsFromMysqlTable Select column details from information schema and return map of map 12 | func GetColumnsFromMysqlTable(mariadbUser string, mariadbPassword string, mariadbHost string, mariadbPort int, mariadbDatabase string, mariadbTable string) (*map[string]map[string]string, []string, error) { 13 | 14 | var err error 15 | var db *sql.DB 16 | if strings.HasPrefix(mariadbHost, "unix:") { 17 | parts := strings.SplitN(mariadbHost, ":", 2) 18 | socketPath := parts[1] 19 | db, err = sql.Open("mysql", mariadbUser+":"+mariadbPassword+"@unix("+socketPath+")"+"/"+mariadbDatabase+"?charset=utf8&parseTime=True") 20 | // Cite: https://dev.mysql.com/doc/mysql-shell/8.0/en/mysql-shell-connection-socket.html 21 | // Cite: https://stackoverflow.com/a/67867865/71978 22 | } else { 23 | if mariadbPassword != "" { 24 | db, err = sql.Open("mysql", mariadbUser+":"+mariadbPassword+"@tcp("+mariadbHost+":"+strconv.Itoa(mariadbPort)+")/"+mariadbDatabase+"?&parseTime=True") 25 | } else { 26 | db, err = sql.Open("mysql", mariadbUser+"@tcp("+mariadbHost+":"+strconv.Itoa(mariadbPort)+")/"+mariadbDatabase+"?&parseTime=True") 27 | } 28 | } 29 | defer db.Close() 30 | 31 | // Check for error in db, note this does not check connectivity but does check uri 32 | if err != nil { 33 | fmt.Println("Error opening mysql db: " + err.Error()) 34 | return nil, nil, err 35 | } 36 | 37 | columnNamesSorted := []string{} 38 | 39 | // Store colum as map of maps 40 | columnDataTypes := make(map[string]map[string]string) 41 | // Select columnd data from INFORMATION_SCHEMA 42 | columnDataTypeQuery := "SELECT COLUMN_NAME, COLUMN_KEY, DATA_TYPE, IS_NULLABLE, COLUMN_COMMENT FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_SCHEMA = ? AND table_name = ? order by ordinal_position asc" 43 | 44 | if Debug { 45 | fmt.Println("running: " + columnDataTypeQuery) 46 | } 47 | 48 | rows, err := db.Query(columnDataTypeQuery, mariadbDatabase, mariadbTable) 49 | 50 | if err != nil { 51 | fmt.Println("Error selecting from db: " + err.Error()) 52 | return nil, nil, err 53 | } 54 | if rows != nil { 55 | defer rows.Close() 56 | } else { 57 | return nil, nil, errors.New("No results returned for table") 58 | } 59 | 60 | for rows.Next() { 61 | var column string 62 | var columnKey string 63 | var dataType string 64 | var nullable string 65 | var comment string 66 | rows.Scan(&column, &columnKey, &dataType, &nullable, &comment) 67 | 68 | columnDataTypes[column] = map[string]string{"value": dataType, "nullable": nullable, "primary": columnKey, "comment": comment} 69 | columnNamesSorted = append(columnNamesSorted, column) 70 | } 71 | 72 | return &columnDataTypes, columnNamesSorted, err 73 | } 74 | 75 | // Generate go struct entries for a map[string]interface{} structure 76 | func generateMysqlTypes(obj map[string]map[string]string, columnsSorted []string, depth int, jsonAnnotation bool, gormAnnotation bool, gureguTypes bool) string { 77 | structure := "struct {" 78 | 79 | for _, key := range columnsSorted { 80 | mysqlType := obj[key] 81 | nullable := false 82 | if mysqlType["nullable"] == "YES" { 83 | nullable = true 84 | } 85 | 86 | primary := "" 87 | if mysqlType["primary"] == "PRI" { 88 | primary = ";primary_key" 89 | } 90 | 91 | // Get the corresponding go value type for this mysql type 92 | var valueType string 93 | // If the guregu (https://github.com/guregu/null) CLI option is passed use its types, otherwise use go's sql.NullX 94 | 95 | valueType = mysqlTypeToGoType(mysqlType["value"], nullable, gureguTypes) 96 | 97 | fieldName := fmtFieldName(stringifyFirstChar(key)) 98 | var annotations []string 99 | if gormAnnotation == true { 100 | annotations = append(annotations, fmt.Sprintf("gorm:\"column:%s%s\"", key, primary)) 101 | } 102 | if jsonAnnotation == true { 103 | annotations = append(annotations, fmt.Sprintf("json:\"%s\"", key)) 104 | } 105 | 106 | if len(annotations) > 0 { 107 | // add colulmn comment 108 | comment := mysqlType["comment"] 109 | structure += fmt.Sprintf("\n%s %s `%s` //%s", fieldName, valueType, strings.Join(annotations, " "), comment) 110 | //structure += fmt.Sprintf("\n%s %s `%s`", fieldName, valueType, strings.Join(annotations, " ")) 111 | } else { 112 | structure += fmt.Sprintf("\n%s %s", fieldName, valueType) 113 | } 114 | } 115 | return structure 116 | } 117 | 118 | // mysqlTypeToGoType converts the mysql types to go compatible sql.Nullable (https://golang.org/pkg/database/sql/) types 119 | func mysqlTypeToGoType(mysqlType string, nullable bool, gureguTypes bool) string { 120 | switch mysqlType { 121 | case "tinyint", "int", "smallint", "mediumint": 122 | if nullable { 123 | if gureguTypes { 124 | return gureguNullInt 125 | } 126 | return sqlNullInt 127 | } 128 | return golangInt 129 | case "bigint": 130 | if nullable { 131 | if gureguTypes { 132 | return gureguNullInt 133 | } 134 | return sqlNullInt 135 | } 136 | return golangInt64 137 | case "char", "enum", "varchar", "longtext", "mediumtext", "text", "tinytext", "json": 138 | if nullable { 139 | if gureguTypes { 140 | return gureguNullString 141 | } 142 | return sqlNullString 143 | } 144 | return "string" 145 | case "date", "datetime", "time", "timestamp": 146 | if nullable && gureguTypes { 147 | return gureguNullTime 148 | } 149 | return golangTime 150 | case "decimal", "double": 151 | if nullable { 152 | if gureguTypes { 153 | return gureguNullFloat 154 | } 155 | return sqlNullFloat 156 | } 157 | return golangFloat64 158 | case "float": 159 | if nullable { 160 | if gureguTypes { 161 | return gureguNullFloat 162 | } 163 | return sqlNullFloat 164 | } 165 | return golangFloat32 166 | case "binary", "blob", "longblob", "mediumblob", "varbinary": 167 | return golangByteArray 168 | } 169 | return "" 170 | } 171 | -------------------------------------------------------------------------------- /utils_mysql_test.go: -------------------------------------------------------------------------------- 1 | package db2struct 2 | 3 | import ( 4 | "testing" 5 | 6 | _ "github.com/go-sql-driver/mysql" // Initialize mysql driver 7 | . "github.com/smartystreets/goconvey/convey" 8 | ) 9 | 10 | const testMariadbUsername = "root" 11 | const testMariadbPassword = "" 12 | const testMariadbHost = "127.0.0.1" 13 | const testMariadbPort = 3306 14 | const testMariadbDatabase = "test" 15 | 16 | func TestGetColumnsFromMysqlTable(t *testing.T) { 17 | var testTable = "all_data_types" 18 | columMap, err := GetColumnsFromMysqlTable(testMariadbUsername, testMariadbPassword, testMariadbHost, testMariadbPort, testMariadbDatabase, testTable) 19 | Convey("Should be able to connect to test database and create columnMap", t, func() { 20 | So(err, ShouldBeNil) 21 | So(columMap, ShouldNotBeNil) 22 | So(*columMap, ShouldNotBeEmpty) 23 | }) 24 | 25 | columMap, err = GetColumnsFromMysqlTable(testMariadbUsername, testMariadbPassword, "doesnotexists", testMariadbPort, testMariadbDatabase, testTable) 26 | Convey("Should get an error connecting to test database", t, func() { 27 | So(err, ShouldNotBeNil) 28 | So(columMap, ShouldBeNil) 29 | }) 30 | } 31 | -------------------------------------------------------------------------------- /utils_test.go: -------------------------------------------------------------------------------- 1 | package db2struct 2 | 3 | import ( 4 | "testing" 5 | 6 | . "github.com/smartystreets/goconvey/convey" 7 | ) 8 | 9 | func TestLintFieldName(t *testing.T) { 10 | name := lintFieldName("_") 11 | Convey("Should get underscore as fieldName", t, func() { 12 | So(name, ShouldEqual, "_") 13 | }) 14 | 15 | name = lintFieldName("foo_id") 16 | Convey("Should be able to convert field name", t, func() { 17 | So(name, ShouldEqual, "FooID") 18 | }) 19 | 20 | name = lintFieldName("foo__id") 21 | Convey("Should be able to convert field name", t, func() { 22 | So(name, ShouldEqual, "FooID") 23 | }) 24 | 25 | name = lintFieldName("1__2") 26 | Convey("Should be able to convert field name", t, func() { 27 | So(name, ShouldEqual, "1_2") 28 | }) 29 | 30 | name = lintFieldName("_id") 31 | Convey("Should be able to convert field name", t, func() { 32 | So(name, ShouldEqual, "ID") 33 | }) 34 | 35 | name = lintFieldName("foo") 36 | Convey("Should be able to convert field name", t, func() { 37 | So(name, ShouldEqual, "Foo") 38 | }) 39 | } 40 | 41 | func TestMysqlStringGenerate(t *testing.T) { 42 | expectedStruct := 43 | `package test 44 | 45 | type testStruct struct { 46 | NullStringColumn sql.NullString 47 | StringColumn string 48 | } 49 | ` 50 | 51 | columnMap := map[string]map[string]string{ 52 | "stringColumn": {"nullable": "NO", "value": "varchar"}, 53 | "nullStringColumn": {"nullable": "YES", "value": "varchar"}, 54 | } 55 | bytes, err := Generate(columnMap, "test_table", "testStruct", "test", false, false, false) 56 | 57 | Convey("Should be able to generate map from string column", t, func() { 58 | So(err, ShouldBeNil) 59 | So(string(bytes), ShouldEqual, expectedStruct) 60 | }) 61 | } 62 | 63 | func TestMysqlBlobGenerate(t *testing.T) { 64 | expectedStruct := 65 | `package test 66 | 67 | type testStruct struct { 68 | BinaryColumn []byte 69 | BlobColumn []byte 70 | LongBlobColumn []byte 71 | MediumBlobColumn []byte 72 | NullBinaryColumn []byte 73 | NullBlobColumn []byte 74 | NullLongBlobColumn []byte 75 | NullMediumBlobColumn []byte 76 | NullVarbinaryColumn []byte 77 | VarbinaryColumn []byte 78 | } 79 | ` 80 | 81 | columnMap := map[string]map[string]string{ 82 | "binaryColumn": {"nullable": "NO", "value": "binary"}, 83 | "nullBinaryColumn": {"nullable": "YES", "value": "binary"}, 84 | "blobColumn": {"nullable": "NO", "value": "blob"}, 85 | "nullBlobColumn": {"nullable": "YES", "value": "blob"}, 86 | "longBlobColumn": {"nullable": "NO", "value": "longblob"}, 87 | "nullLongBlobColumn": {"nullable": "YES", "value": "longblob"}, 88 | "mediumBlobColumn": {"nullable": "NO", "value": "mediumblob"}, 89 | "nullMediumBlobColumn": {"nullable": "YES", "value": "mediumblob"}, 90 | "varbinaryColumn": {"nullable": "NO", "value": "varbinary"}, 91 | "nullVarbinaryColumn": {"nullable": "YES", "value": "varbinary"}, 92 | } 93 | bytes, err := Generate(columnMap, "test_table", "testStruct", "test", false, false, false) 94 | 95 | Convey("Should be able to generate map from string column", t, func() { 96 | So(err, ShouldBeNil) 97 | So(string(bytes), ShouldEqual, expectedStruct) 98 | }) 99 | } 100 | 101 | func TestMysqlDateGenerate(t *testing.T) { 102 | columnMap := map[string]map[string]string{ 103 | "DateColumn": {"nullable": "NO", "value": "date"}, 104 | "nullDateColumn": {"nullable": "YES", "value": "date"}, 105 | "DateTimeColumn": {"nullable": "NO", "value": "datetime"}, 106 | "nullDateTimeColumn": {"nullable": "YES", "value": "datetime"}, 107 | "TimeColumn": {"nullable": "NO", "value": "time"}, 108 | "nullTimeColumn": {"nullable": "YES", "value": "time"}, 109 | "TimeStampColumn": {"nullable": "NO", "value": "timestamp"}, 110 | "nullTimeStampColumn": {"nullable": "YES", "value": "timestamp"}, 111 | } 112 | 113 | expectedStruct := 114 | `package test 115 | 116 | type testStruct struct { 117 | DateColumn time.Time 118 | DateTimeColumn time.Time 119 | TimeColumn time.Time 120 | TimeStampColumn time.Time 121 | NullDateColumn time.Time 122 | NullDateTimeColumn time.Time 123 | NullTimeColumn time.Time 124 | NullTimeStampColumn time.Time 125 | } 126 | ` 127 | 128 | bytes, err := Generate(columnMap, "test_table", "testStruct", "test", false, false, false) 129 | 130 | Convey("Should be able to generate map from string column", t, func() { 131 | So(err, ShouldBeNil) 132 | So(string(bytes), ShouldEqual, expectedStruct) 133 | }) 134 | 135 | expectedStruct = 136 | `package test 137 | 138 | type testStruct struct { 139 | DateColumn time.Time 140 | DateTimeColumn time.Time 141 | TimeColumn time.Time 142 | TimeStampColumn time.Time 143 | NullDateColumn null.Time 144 | NullDateTimeColumn null.Time 145 | NullTimeColumn null.Time 146 | NullTimeStampColumn null.Time 147 | } 148 | ` 149 | 150 | bytes, err = Generate(columnMap, "test_table", "testStruct", "test", false, false, true) 151 | 152 | Convey("Should be able to generate map from string column", t, func() { 153 | So(err, ShouldBeNil) 154 | So(string(bytes), ShouldEqual, expectedStruct) 155 | }) 156 | } 157 | 158 | func TestMysqlFloatGenerate(t *testing.T) { 159 | 160 | columnMap := map[string]map[string]string{ 161 | "floatColumn": {"nullable": "NO", "value": "float"}, 162 | "nullFloatColumn": {"nullable": "YES", "value": "float"}, 163 | "doubleColumn": {"nullable": "NO", "value": "double"}, 164 | "nullDoubleColumn": {"nullable": "YES", "value": "double"}, 165 | "decimalColumn": {"nullable": "NO", "value": "decimal"}, 166 | "nullDecimalColumn": {"nullable": "YES", "value": "decimal"}, 167 | } 168 | 169 | expectedStruct := 170 | `package test 171 | 172 | type testStruct struct { 173 | DecimalColumn float64 174 | DoubleColumn float64 175 | FloatColumn float32 176 | NullDecimalColumn sql.NullFloat64 177 | NullDoubleColumn sql.NullFloat64 178 | NullFloatColumn sql.NullFloat64 179 | } 180 | ` 181 | 182 | bytes, err := Generate(columnMap, "test_table", "testStruct", "test", false, false, false) 183 | 184 | Convey("Should be able to generate map from string column", t, func() { 185 | So(err, ShouldBeNil) 186 | So(string(bytes), ShouldEqual, expectedStruct) 187 | }) 188 | 189 | expectedStruct = 190 | `package test 191 | 192 | type testStruct struct { 193 | DecimalColumn float64 194 | DoubleColumn float64 195 | FloatColumn float32 196 | NullDecimalColumn null.Float 197 | NullDoubleColumn null.Float 198 | NullFloatColumn null.Float 199 | } 200 | ` 201 | 202 | bytes, err = Generate(columnMap, "test_table", "testStruct", "test", false, false, true) 203 | 204 | Convey("Should be able to generate map from string column", t, func() { 205 | So(err, ShouldBeNil) 206 | So(string(bytes), ShouldEqual, expectedStruct) 207 | }) 208 | } 209 | 210 | func TestMysqlIntGenerate(t *testing.T) { 211 | columnMap := map[string]map[string]string{ 212 | "intColumn": {"nullable": "NO", "value": "int"}, 213 | "nullIntColumn": {"nullable": "YES", "value": "int"}, 214 | "tinyIntColumn": {"nullable": "NO", "value": "tinyint"}, 215 | "nullTinyIntColumn": {"nullable": "YES", "value": "tinyint"}, 216 | "smallIntColumn": {"nullable": "NO", "value": "smallint"}, 217 | "nullSmallIntColumn": {"nullable": "YES", "value": "smallint"}, 218 | "mediumIntColumn": {"nullable": "NO", "value": "mediumint"}, 219 | "nullMediumIntColumn": {"nullable": "YES", "value": "mediumint"}, 220 | "bigIntColumn": {"nullable": "NO", "value": "bigint"}, 221 | "nullBigIntColumn": {"nullable": "YES", "value": "bigint"}, 222 | } 223 | 224 | expectedStruct := 225 | `package test 226 | 227 | type testStruct struct { 228 | BigIntColumn int64 229 | IntColumn int 230 | MediumIntColumn int 231 | NullBigIntColumn sql.NullInt64 232 | NullIntColumn sql.NullInt64 233 | NullMediumIntColumn sql.NullInt64 234 | NullSmallIntColumn sql.NullInt64 235 | NullTinyIntColumn sql.NullInt64 236 | SmallIntColumn int 237 | TinyIntColumn int 238 | } 239 | ` 240 | 241 | bytes, err := Generate(columnMap, "test_table", "testStruct", "test", false, false, false) 242 | 243 | Convey("Should be able to generate map from string column", t, func() { 244 | So(err, ShouldBeNil) 245 | So(string(bytes), ShouldEqual, expectedStruct) 246 | }) 247 | 248 | expectedStruct = 249 | `package test 250 | 251 | type testStruct struct { 252 | BigIntColumn int64 253 | IntColumn int 254 | MediumIntColumn int 255 | NullBigIntColumn null.Int 256 | NullIntColumn null.Int 257 | NullMediumIntColumn null.Int 258 | NullSmallIntColumn null.Int 259 | NullTinyIntColumn null.Int 260 | SmallIntColumn int 261 | TinyIntColumn int 262 | } 263 | ` 264 | 265 | bytes, err = Generate(columnMap, "test_table", "testStruct", "test", false, false, true) 266 | 267 | Convey("Should be able to generate map from string column", t, func() { 268 | So(err, ShouldBeNil) 269 | So(string(bytes), ShouldEqual, expectedStruct) 270 | }) 271 | } 272 | 273 | func TestMysqlJSONStringGenerate(t *testing.T) { 274 | columnMap := map[string]map[string]string{ 275 | "stringColumn": {"nullable": "NO", "value": "varchar"}, 276 | "nullStringColumn": {"nullable": "YES", "value": "varchar"}, 277 | } 278 | 279 | expectedStruct := 280 | `package test 281 | 282 | type testStruct struct { 283 | NullStringColumn sql.NullString ` + "`json:\"nullStringColumn\"`" + ` 284 | StringColumn string ` + "`json:\"stringColumn\"`" + ` 285 | } 286 | ` 287 | 288 | bytes, err := Generate(columnMap, "test_table", "testStruct", "test", true, false, false) 289 | 290 | Convey("Should be able to generate map from string column", t, func() { 291 | So(err, ShouldBeNil) 292 | So(string(bytes), ShouldEqual, expectedStruct) 293 | }) 294 | } 295 | 296 | func TestMysqlGormStringGenerate(t *testing.T) { 297 | expectedStruct := 298 | `package test 299 | 300 | type testStruct struct { 301 | NullStringColumn sql.NullString ` + "`gorm:\"column:nullStringColumn\"`" + ` 302 | StringColumn string ` + "`gorm:\"column:stringColumn\"`" + ` 303 | } 304 | 305 | // TableName sets the insert table name for this struct type 306 | func (t *testStruct) TableName() string { 307 | return "test_table" 308 | } 309 | ` 310 | 311 | columnMap := map[string]map[string]string{ 312 | "stringColumn": {"nullable": "NO", "value": "varchar"}, 313 | "nullStringColumn": {"nullable": "YES", "value": "varchar"}, 314 | } 315 | bytes, err := Generate(columnMap, "test_table", "testStruct", "test", false, true, false) 316 | 317 | Convey("Should be able to generate map from string column", t, func() { 318 | So(err, ShouldBeNil) 319 | So(string(bytes), ShouldEqual, expectedStruct) 320 | }) 321 | } 322 | 323 | func TestMysqlStringWithIntGenerate(t *testing.T) { 324 | expectedStruct := 325 | `package test 326 | 327 | type testStruct struct { 328 | OneStringColumn string 329 | } 330 | ` 331 | 332 | columnMap := map[string]map[string]string{ 333 | "1stringColumn": {"nullable": "NO", "value": "varchar"}, 334 | } 335 | bytes, err := Generate(columnMap, "test_table", "testStruct", "test", false, false, false) 336 | 337 | Convey("Should be able to generate map from string column", t, func() { 338 | So(err, ShouldBeNil) 339 | So(string(bytes), ShouldEqual, expectedStruct) 340 | }) 341 | } 342 | 343 | func TestMysqlStringWithUnderscoresGenerate(t *testing.T) { 344 | expectedStruct := 345 | `package test 346 | 347 | type testStruct struct { 348 | StringColumn string 349 | } 350 | ` 351 | 352 | columnMap := map[string]map[string]string{ 353 | "string_Column": {"nullable": "NO", "value": "varchar"}, 354 | } 355 | bytes, err := Generate(columnMap, "test_table", "testStruct", "test", false, false, false) 356 | 357 | Convey("Should be able to generate map from string column", t, func() { 358 | So(err, ShouldBeNil) 359 | So(string(bytes), ShouldEqual, expectedStruct) 360 | }) 361 | } 362 | 363 | func TestMysqlStringWithCommonInitialismGenerate(t *testing.T) { 364 | expectedStruct := 365 | `package test 366 | 367 | type testStruct struct { 368 | API string 369 | } 370 | ` 371 | 372 | columnMap := map[string]map[string]string{ 373 | "API": {"nullable": "NO", "value": "varchar"}, 374 | } 375 | bytes, err := Generate(columnMap, "test_table", "testStruct", "test", false, false, false) 376 | 377 | Convey("Should be able to generate map from string column", t, func() { 378 | So(err, ShouldBeNil) 379 | So(string(bytes), ShouldEqual, expectedStruct) 380 | }) 381 | } 382 | 383 | // TestMysqlTypeToGureguType generates the struct and outputs nullable columns as guregu null types 384 | func TestMysqlTypeToGureguType(t *testing.T) { 385 | expectedStruct := 386 | `package test 387 | 388 | type testStruct struct { 389 | BigInt int64 390 | Date null.Time 391 | DateTime null.Time 392 | Decimal null.Float 393 | Double float64 394 | Float null.Float 395 | Int null.Int 396 | Time time.Time 397 | TimeStamp null.Time 398 | TinyInt int 399 | VarChar null.String 400 | } 401 | ` 402 | 403 | columnMap := map[string]map[string]string{ 404 | "VarChar": {"nullable": "YES", "value": "varchar"}, 405 | "TinyInt": {"nullable": "NO", "value": "tinyint"}, 406 | "Int": {"nullable": "YES", "value": "int"}, 407 | "BigInt": {"nullable": "NO", "value": "bigint"}, 408 | "Decimal": {"nullable": "YES", "value": "decimal"}, 409 | "Float": {"nullable": "YES", "value": "float"}, 410 | "Double": {"nullable": "NO", "value": "double"}, 411 | "DateTime": {"nullable": "YES", "value": "datetime"}, 412 | "Time": {"nullable": "NO", "value": "time"}, 413 | "Date": {"nullable": "YES", "value": "date"}, 414 | "TimeStamp": {"nullable": "YES", "value": "timestamp"}, 415 | } 416 | 417 | bytes, err := Generate(columnMap, "test_table", "testStruct", "test", false, false, true) 418 | 419 | Convey("Should be able to generate map for guregu types", t, func() { 420 | So(err, ShouldBeNil) 421 | So(string(bytes), ShouldEqual, expectedStruct) 422 | }) 423 | } 424 | --------------------------------------------------------------------------------