├── .gitignore ├── .ocamlformat ├── CHANGES.md ├── COPYING ├── Makefile ├── README.md ├── dune-project ├── fun-postgresql.opam ├── fun-sql.opam ├── fun-sqlite.opam ├── fun_postgresql ├── dune ├── fun_postgresql.ml ├── fun_postgresql.mli └── impl.ml ├── fun_sql ├── dune └── fun_sql.ml ├── fun_sqlite ├── dune ├── fun_sqlite.ml ├── fun_sqlite.mli └── impl.ml ├── ppx ├── dune ├── ppx_deriving_funsql.ml └── ppx_deriving_funsql.mli ├── ppx_deriving_funsql.opam ├── test_fun_postgresql ├── dune ├── test_fun_postgresql.expected.stdout └── test_fun_postgresql.ml ├── test_fun_sqlite ├── dune ├── test_fun_sqlite.expected.stdout └── test_fun_sqlite.ml └── test_ppx ├── dune ├── test.expected.ml ├── test.ml └── test_ppx.ml /.gitignore: -------------------------------------------------------------------------------- 1 | _build 2 | *.db 3 | .vscode/ 4 | -------------------------------------------------------------------------------- /.ocamlformat: -------------------------------------------------------------------------------- 1 | profile = default 2 | 3 | break-string-literals = never 4 | dock-collection-brackets = false 5 | leading-nested-match-parens = false 6 | parens-tuple = multi-line-only 7 | space-around-variants = false 8 | space-around-arrays = false 9 | space-around-lists = false 10 | space-around-records = true 11 | break-infix = fit-or-vertical 12 | break-separators = after 13 | break-cases = fit-or-vertical 14 | cases-exp-indent = 2 15 | exp-grouping = preserve 16 | if-then-else = fit-or-vertical 17 | let-and = sparse 18 | type-decl = sparse 19 | -------------------------------------------------------------------------------- /CHANGES.md: -------------------------------------------------------------------------------- 1 | ## v0.0.1 2 | 3 | Please refer to release notes in tags. 4 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | 635 | Copyright (C) 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 | Copyright (C) 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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | DOCPATH=$(PWD)/_build/default/_doc/_html 2 | 3 | .PHONY : publish_doc 4 | publish_doc : odoc 5 | @chmod 644 $(DOCPATH)/index.html &&\ 6 | git checkout gh-pages &&\ 7 | cp -R $(DOCPATH)/* . &&\ 8 | git commit -a --amend -mdocs &&\ 9 | git push --force &&\ 10 | git checkout - 11 | 12 | .PHONY : publish_opam 13 | publish_opam : 14 | @dune-release distrib && dune-release publish distrib && dune-release opam pkg -y && dune-release opam submit -y 15 | 16 | .PHONY : doc 17 | doc : odoc 18 | @echo "Documentation generated at file://$(DOCPATH)/index.html" 19 | 20 | .PHONY : odoc 21 | odoc : 22 | @dune build @doc 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## fun-sql - functional-style SQL queries for OCaml 2 | 3 | Copyright 2022 Yawar Amin 4 | 5 | This file is part of fun-sql. 6 | 7 | fun-sql is free software: you can redistribute it and/or modify it under the 8 | terms of the GNU General Public License as published by the Free Software 9 | Foundation, either version 3 of the License, or (at your option) any later 10 | version. 11 | 12 | fun-sql is distributed in the hope that it will be useful, but WITHOUT ANY 13 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 14 | PARTICULAR PURPOSE. See the GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License along with fun- 17 | sql. If not, see . 18 | 19 | ### What is this 20 | 21 | A simple functional-style query runner and mapper for PostgreSQL and SQLite 22 | (MySQL support is also desired if anyone wants to contribute!). 23 | 24 | Designed to make it easy to create prepared statements and then use them: 25 | 26 | ```ocaml 27 | (* Prepared statement: *) 28 | let edit_note = query db "update note set txt = ? where id = $2" 29 | 30 | (* Use by simply calling it: *) 31 | let edit_note id txt = edit_note Arg.[int id; text txt] Fun_sql.unit 32 | ``` 33 | 34 | ### Examples 35 | 36 | ```ocaml 37 | open Fun_postgresql 38 | (* Or: Fun_sqlite *) 39 | 40 | (* Test DB *) 41 | let db = new Postgresql.connection ~conninfo:"postgresql://..." () 42 | (* Or: let db = Sqlite3.db_open ":memory:" *) 43 | 44 | (* DDL query with no arguments and no return *) 45 | let () = query db "create table people (name text not null, age int)" [] unit 46 | 47 | (* Insert query with single row *) 48 | let () = query 49 | db 50 | (sql "insert into people (name, age) values (%a, %a)" placeholder 0 placeholder 1) 51 | Arg.[text "A"; int 1] 52 | unit 53 | 54 | (* Get single column of results from DB *) 55 | let names = query 56 | db 57 | (sql "select name from people where age = %a" placeholder 0) 58 | Arg.[int 1] 59 | (ret (text 0)) 60 | (* val names : string Seq.t = *) 61 | 62 | let () = 63 | query 64 | db 65 | (sql "insert into people (name) values (%a)" placeholder 0) 66 | Arg.[text "B"] 67 | unit 68 | 69 | (* Get optional values *) 70 | let ages = all (query db "select age from people" [] (ret (opt int 0))) 71 | (* val ages : int option list = [Some 1; None] *) 72 | 73 | (* Map return data to a custom type on the fly–see also below for a PPX deriver 74 | that automates this boilerplate *) 75 | type person = { name : string; age : int option } 76 | 77 | let ret = ret (fun row -> { name = text 0 row; age = opt int 1 row }) 78 | (* val ret : (row, person Seq.t) ret *) 79 | 80 | (* Assert resultset has at most a single row and map it *) 81 | let person_1 = 82 | one ( 83 | query 84 | db 85 | (sql "select name, age from people where age = %a" placeholder 0) 86 | Arg.[int 1] 87 | ret) 88 | (* val person_1 : person option = Some {name = "A"; age = Some 1} *) 89 | 90 | (* Batch insert *) 91 | 92 | let ppl = [{ name = "B"; age = None }; { name = "C"; age = Some 3 }] 93 | 94 | (* Batch insert works with SQLite only: *) 95 | let () = batch_insert 96 | db 97 | (sql "insert into people (name, age) values (%a, %a)" placeholder 0 placeholder 1) 98 | ppl 99 | (fun { name; age } -> Arg.[text name; opt int age]) 100 | unit 101 | ``` 102 | 103 | ### PPX 104 | 105 | There is support for deriving resultset row decoders: 106 | 107 | > [!NOTE] 108 | > One of the query modules _must_ be `open`ed for the PPX to work, ie either 109 | > `Fun_sqlite` or `Fun_postgresql`. You can avoid polluting your scope by putting 110 | > the `open`s inside submodules. 111 | 112 | To use the PPX, add to your `dune` file, eg: 113 | 114 | ``` 115 | (executable 116 | ... 117 | (preprocess (pps ppx_deriving_funsql))) 118 | ``` 119 | 120 | And to your `dune-project` file: 121 | 122 | ``` 123 | (package 124 | ... 125 | (depends 126 | ... 127 | ppx_deriving_funsql 128 | ...)) 129 | ``` 130 | 131 | ### Deriving for custom types with the PPX 132 | 133 | The PPX supports the following basic types: 134 | 135 | - `int` 136 | - `string` 137 | - `float` 138 | - `int64` 139 | - `bool` 140 | - `t option` where `t` is a type which can be derived. This can be used to 141 | represent a nullable type. 142 | 143 | It also supports custom types as long as the type is in a module which conforms 144 | to the signature: 145 | 146 | ```ocaml 147 | sig 148 | type t 149 | val of_string : string -> t 150 | end 151 | ``` 152 | 153 | In other words it uses the module to 'find' the parser of the type from its 154 | string representation. Eg: 155 | 156 | ``` 157 | # #require "decimal";; 158 | # #install_printer Decimal.pp;; 159 | # let db = Sqlite3.db_open "fun.db";; 160 | val db : Sqlite3.db = 161 | # module Person = struct 162 | open Fun_sqlite 163 | 164 | type t = { name : string; age : Decimal.t option } [@@deriving funsql] 165 | 166 | let by_name = query db (sql "select name, age from people where name = %a" placeholder 0) 167 | let by_name name = by_name Arg.[text name] ret 168 | end;; 169 | module Person : 170 | sig 171 | type t = { name : string; age : Decimal.t option; } 172 | val ret : (row, t Seq.t) ret 173 | val by_name : string -> t Seq.t 174 | end 175 | # all (Person.by_name "Bob");; 176 | - : Person.t list = [{Person.name = "Bob"; age = Some 32}] 177 | # one (Person.by_name "X");; 178 | - : Person.t option = Some {Person.name = "X"; age = Some 22} 179 | ``` 180 | 181 | > [!WARNING] 182 | > The record type fields must be declared in the same order as the `select` 183 | > clause fields in the SQL query, as the deriver relies on this ordering. 184 | 185 | I believe this is not a huge problem though, because fortunately OCaml makes it 186 | easy to create small, dedicated submodules for each query as needed. 187 | -------------------------------------------------------------------------------- /dune-project: -------------------------------------------------------------------------------- 1 | (lang dune 2.7) 2 | 3 | (name fun-sql) 4 | 5 | (version v0.4.0) 6 | 7 | (generate_opam_files true) 8 | 9 | (license GPL-3.0-or-later) 10 | 11 | (authors "Yawar Amin ") 12 | 13 | (maintainers "Yawar Amin ") 14 | 15 | (source 16 | (github yawaramin/fun-sql)) 17 | 18 | (package 19 | (name fun-sql) 20 | (synopsis "Shared code for SQL libraries") 21 | (description 22 | "Shared code for SQL packages, use fun-sqlite or fun-postgresql directly depending on which database you are using.") 23 | (documentation https://yawaramin.github.io/fun-sql/fun-sql/Fun_sql/) 24 | (tags 25 | (org:yawaramin fun-sql)) 26 | (depends 27 | (ocaml 28 | (>= 4.14.0)))) 29 | 30 | (package 31 | (name fun-sqlite) 32 | (synopsis "SQLite query support") 33 | (description "Use this package for running SQLite queries.") 34 | (documentation https://yawaramin.github.io/fun-sql/fun-sqlite/Fun_sqlite/) 35 | (tags 36 | (org:yawaramin fun-sql)) 37 | (depends 38 | (fun-sql 39 | (= :version)) 40 | (sqlite3 41 | (and 42 | (>= 5.1.0) 43 | (< 6.0.0))))) 44 | 45 | (package 46 | (name fun-postgresql) 47 | (synopsis "PostgreSQL query support") 48 | (description "Use this package for running PostgreSQL queries.") 49 | (documentation 50 | https://yawaramin.github.io/fun-sql/fun-postgresql/Fun_postgresql/) 51 | (tags 52 | (org:yawaramin fun-sql)) 53 | (depends 54 | (fun-sql 55 | (= :version)) 56 | (postgresql 57 | (and 58 | (>= 5.0.0) 59 | (< 6.0.0))))) 60 | 61 | (package 62 | (name ppx_deriving_funsql) 63 | (synopsis "PPX deriver for query row decoding into OCaml types") 64 | (description 65 | "This is a convenience PPX that takes care of the boilerplate of writing the conversion from query result rows to OCaml types.") 66 | (documentation https://yawaramin.github.io/fun-sql/) 67 | (tags 68 | (org:yawaramin fun-sql)) 69 | (depends 70 | (ppxlib 71 | (and 72 | (>= 0.32.1) 73 | (< 1.0.0))))) 74 | -------------------------------------------------------------------------------- /fun-postgresql.opam: -------------------------------------------------------------------------------- 1 | # This file is generated by dune, edit dune-project instead 2 | opam-version: "2.0" 3 | version: "v0.4.0" 4 | synopsis: "PostgreSQL query support" 5 | description: "Use this package for running PostgreSQL queries." 6 | maintainer: ["Yawar Amin "] 7 | authors: ["Yawar Amin "] 8 | license: "GPL-3.0-or-later" 9 | tags: ["org:yawaramin" "fun-sql"] 10 | homepage: "https://github.com/yawaramin/fun-sql" 11 | doc: "https://yawaramin.github.io/fun-sql/fun-postgresql/Fun_postgresql/" 12 | bug-reports: "https://github.com/yawaramin/fun-sql/issues" 13 | depends: [ 14 | "dune" {>= "2.7"} 15 | "fun-sql" {= version} 16 | "postgresql" {>= "5.0.0" & < "6.0.0"} 17 | "odoc" {with-doc} 18 | ] 19 | build: [ 20 | ["dune" "subst"] {dev} 21 | [ 22 | "dune" 23 | "build" 24 | "-p" 25 | name 26 | "-j" 27 | jobs 28 | "@install" 29 | "@runtest" {with-test} 30 | "@doc" {with-doc} 31 | ] 32 | ] 33 | dev-repo: "git+https://github.com/yawaramin/fun-sql.git" 34 | -------------------------------------------------------------------------------- /fun-sql.opam: -------------------------------------------------------------------------------- 1 | # This file is generated by dune, edit dune-project instead 2 | opam-version: "2.0" 3 | version: "v0.4.0" 4 | synopsis: "Shared code for SQL libraries" 5 | description: 6 | "Shared code for SQL packages, use fun-sqlite or fun-postgresql directly depending on which database you are using." 7 | maintainer: ["Yawar Amin "] 8 | authors: ["Yawar Amin "] 9 | license: "GPL-3.0-or-later" 10 | tags: ["org:yawaramin" "fun-sql"] 11 | homepage: "https://github.com/yawaramin/fun-sql" 12 | doc: "https://yawaramin.github.io/fun-sql/fun-sql/Fun_sql/" 13 | bug-reports: "https://github.com/yawaramin/fun-sql/issues" 14 | depends: [ 15 | "dune" {>= "2.7"} 16 | "ocaml" {>= "4.14.0"} 17 | "odoc" {with-doc} 18 | ] 19 | build: [ 20 | ["dune" "subst"] {dev} 21 | [ 22 | "dune" 23 | "build" 24 | "-p" 25 | name 26 | "-j" 27 | jobs 28 | "@install" 29 | "@runtest" {with-test} 30 | "@doc" {with-doc} 31 | ] 32 | ] 33 | dev-repo: "git+https://github.com/yawaramin/fun-sql.git" 34 | -------------------------------------------------------------------------------- /fun-sqlite.opam: -------------------------------------------------------------------------------- 1 | # This file is generated by dune, edit dune-project instead 2 | opam-version: "2.0" 3 | version: "v0.4.0" 4 | synopsis: "SQLite query support" 5 | description: "Use this package for running SQLite queries." 6 | maintainer: ["Yawar Amin "] 7 | authors: ["Yawar Amin "] 8 | license: "GPL-3.0-or-later" 9 | tags: ["org:yawaramin" "fun-sql"] 10 | homepage: "https://github.com/yawaramin/fun-sql" 11 | doc: "https://yawaramin.github.io/fun-sql/fun-sqlite/Fun_sqlite/" 12 | bug-reports: "https://github.com/yawaramin/fun-sql/issues" 13 | depends: [ 14 | "dune" {>= "2.7"} 15 | "fun-sql" {= version} 16 | "sqlite3" {>= "5.1.0" & < "6.0.0"} 17 | "odoc" {with-doc} 18 | ] 19 | build: [ 20 | ["dune" "subst"] {dev} 21 | [ 22 | "dune" 23 | "build" 24 | "-p" 25 | name 26 | "-j" 27 | jobs 28 | "@install" 29 | "@runtest" {with-test} 30 | "@doc" {with-doc} 31 | ] 32 | ] 33 | dev-repo: "git+https://github.com/yawaramin/fun-sql.git" 34 | -------------------------------------------------------------------------------- /fun_postgresql/dune: -------------------------------------------------------------------------------- 1 | (library 2 | (name fun_postgresql) 3 | (public_name fun-postgresql) 4 | (libraries fun-sql postgresql)) 5 | -------------------------------------------------------------------------------- /fun_postgresql/fun_postgresql.ml: -------------------------------------------------------------------------------- 1 | (* Copyright 2024 Yawar Amin 2 | 3 | This file is part of fun-sql. 4 | 5 | fun-sql is free software: you can redistribute it and/or modify it under the 6 | terms of the GNU General Public License as published by the Free Software 7 | Foundation, either version 3 of the License, or (at your option) any later 8 | version. 9 | 10 | fun-sql is distributed in the hope that it will be useful, but WITHOUT ANY 11 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 12 | A PARTICULAR PURPOSE. See the GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License along with 15 | fun-sql. If not, see . *) 16 | 17 | include Impl 18 | include Fun_sql.Make (Impl) 19 | -------------------------------------------------------------------------------- /fun_postgresql/fun_postgresql.mli: -------------------------------------------------------------------------------- 1 | (* Copyright 2024 Yawar Amin 2 | 3 | This file is part of fun-sql. 4 | 5 | fun-sql is free software: you can redistribute it and/or modify it under the 6 | terms of the GNU General Public License as published by the Free Software 7 | Foundation, either version 3 of the License, or (at your option) any later 8 | version. 9 | 10 | fun-sql is distributed in the hope that it will be useful, but WITHOUT ANY 11 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 12 | A PARTICULAR PURPOSE. See the GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License along with 15 | fun-sql. If not, see . *) 16 | 17 | (** Use this module for PostgreSQL database queries. 18 | 19 | Note: does not support [batch_insert] out of the box because PostgreSQL uses 20 | numbered placeholders, which makes it much more difficult to parse out and 21 | modify the insert query with the correct number of placeholders. *) 22 | 23 | include 24 | Fun_sql.Query_sig with type ('row, 'r) ret = ('row, 'r) Fun_sql.Query.ret 25 | 26 | include 27 | Fun_sql.Sql 28 | with type db = Postgresql.connection 29 | and type arg = string 30 | and type row = string array 31 | 32 | include Fun_sql.S with type db := db and type arg := arg 33 | -------------------------------------------------------------------------------- /fun_postgresql/impl.ml: -------------------------------------------------------------------------------- 1 | (* Copyright 2024 Yawar Amin 2 | 3 | This file is part of fun-sql. 4 | 5 | fun-sql is free software: you can redistribute it and/or modify it under the 6 | terms of the GNU General Public License as published by the Free Software 7 | Foundation, either version 3 of the License, or (at your option) any later 8 | version. 9 | 10 | fun-sql is distributed in the hope that it will be useful, but WITHOUT ANY 11 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 12 | A PARTICULAR PURPOSE. See the GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License along with 15 | fun-sql. If not, see . *) 16 | 17 | type db = Postgresql.connection 18 | type arg = string 19 | type row = string array 20 | 21 | include Fun_sql.Query 22 | 23 | let placeholder f n = Format.fprintf f "$%d" (n + 1) 24 | 25 | let query : type r. db -> string -> arg list -> (row, r) ret -> r = 26 | fun db sql -> 27 | let stm_name = Digest.(to_hex (string sql)) in 28 | let result = db#prepare stm_name sql in 29 | match result#status with 30 | | Postgresql.Bad_response | Nonfatal_error -> failwith result#error 31 | | Fatal_error -> invalid_arg result#error 32 | | _ -> ( 33 | fun args -> 34 | let params = 35 | match args with 36 | | [] -> None 37 | | _ -> Some (Array.of_list args) 38 | in 39 | let result = db#exec_prepared ?params stm_name in 40 | match result#status with 41 | | Postgresql.Tuples_ok | Command_ok | Single_tuple -> ( 42 | function 43 | | Unit -> () 44 | | Ret decode -> 45 | Seq.init result#ntuples (fun i -> decode (result#get_tuple i))) 46 | | _ -> failwith result#error) 47 | 48 | let exec_script (db : db) sql = 49 | let result = db#exec sql in 50 | match result#status with 51 | | Postgresql.Bad_response | Nonfatal_error -> failwith result#error 52 | | Fatal_error -> invalid_arg result#error 53 | | _ -> () 54 | 55 | module Arg = struct 56 | let text value = value 57 | let bool = string_of_bool 58 | let int = string_of_int 59 | let nativeint = Nativeint.to_string 60 | let int32 = Int32.to_string 61 | let int64 = Int64.to_string 62 | let float value = Printf.sprintf "%f" value 63 | let blob value = value 64 | 65 | let opt data = function 66 | | Some value -> data value 67 | | None -> Postgresql.null 68 | end 69 | 70 | let int64 pos row = Int64.of_string row.(pos) 71 | let int pos row = int_of_string row.(pos) 72 | let bool pos row = bool_of_string row.(pos) 73 | let float pos row = float_of_string row.(pos) 74 | let text pos row = row.(pos) 75 | 76 | let opt dec col row = 77 | if row.(col) = Postgresql.null then None else Some (dec col row) 78 | -------------------------------------------------------------------------------- /fun_sql/dune: -------------------------------------------------------------------------------- 1 | (library 2 | (name fun_sql) 3 | (public_name fun-sql) 4 | (libraries str)) 5 | -------------------------------------------------------------------------------- /fun_sql/fun_sql.ml: -------------------------------------------------------------------------------- 1 | (** This module is used for common code across different SQL database engines. 2 | You normally will use either [Fun_sqlite] or [Fun_postgresql] as your entry- 3 | point for querying. *) 4 | 5 | module type Query_sig = sig 6 | (** {2 Database-agnostic query helpers} *) 7 | 8 | val sql : ('a, Format.formatter, unit, string) format4 -> 'a 9 | (** Convenience for formatting query strings with placeholders. Eg 10 | 11 | {[sql "select name from people where id = %a" placeholder 0]} *) 12 | 13 | type (-'row, 'r) ret 14 | (** A decoder of a single row of the resultset from running a query. *) 15 | 16 | val unit : ('row, unit) ret 17 | (** [unit] indicates that the query doesn't return any meaningful output. *) 18 | 19 | val ret : ('row -> 'r) -> ('row, 'r Seq.t) ret 20 | (** [ret decode] is a custom return type encoding for a resultset into a 21 | sequence of values of the type decoded by [decode]. 22 | 23 | [decode] constructs a value of the custom type if possible, else raises 24 | [Failure]. 25 | 26 | Note that the sequence rows of the resultset is unfolded as it is read from 27 | the database. It can only be traversed {i once,} with e.g. [List.of_seq] or 28 | [Seq.iter]. If traversed multiple times, it will raise [Failure]. 29 | 30 | @raise Invalid_argument if any row cannot be decoded. 31 | @raise Failure if an unexpected result code is encountered. *) 32 | 33 | val one : 'a Seq.t -> 'a option 34 | val all : 'a Seq.t -> 'a list 35 | end 36 | 37 | module Query = struct 38 | let sql = Format.asprintf 39 | 40 | type (-'row, 'r) ret = 41 | | Unit : ('row, unit) ret 42 | (** This is used for queries which do not return result rows. *) 43 | | Ret : ('row -> 'r) -> ('row, 'r Seq.t) ret 44 | (** This is for queries which return result rows. *) 45 | 46 | let unit = Unit 47 | let ret decode = Ret decode 48 | 49 | exception More_than_one 50 | (** Thrown if we are expecting at most one result but get more. *) 51 | 52 | (** [one seq] is [Some a] if [a] is the first and only element of [seq], or 53 | [None] if [seq] is empty. 54 | 55 | @raise More_than_one if [seq] contains more than one element. *) 56 | let one seq = 57 | match seq () with 58 | | Seq.Nil -> None 59 | | Cons (a, seq) -> ( 60 | match seq () with 61 | | Nil -> Some a 62 | | Cons (_, _) -> raise More_than_one) 63 | 64 | (** Get all results together. *) 65 | let all = List.of_seq 66 | end 67 | 68 | (** The definitions supported by a database engine. *) 69 | module type Sql = sig 70 | (** {2 Database-specific definitions} *) 71 | 72 | type db 73 | (** The database connection or file, etc. *) 74 | 75 | type arg 76 | (** A value sent to the database in the place of a query parameter. *) 77 | 78 | type row 79 | (** A tuple from the database. *) 80 | 81 | val placeholder : Format.formatter -> int -> unit 82 | (** A generic way to write placeholders for different database drivers' 83 | prepared statement parameters. 84 | 85 | ℹ️ Placeholders are 0-indexed. *) 86 | 87 | (** {2 Query runners} *) 88 | 89 | val query : db -> string -> arg list -> (row, 'r) Query.ret -> 'r 90 | (** The main function through which queries are run is the [query] function. 91 | This function {e always} creates a prepared statement for each partial call 92 | to [query db sql]. This prepared statement can then be called with the 93 | actual arguments (if any) and the resultset row decoder: 94 | 95 | {[let add_person = 96 | query db (sql "insert into people (name, age) values (%a, %a)" placeholder 0 placeholder 1) 97 | let add_person name age = add_person Arg.[text name; int age] unit]} 98 | 99 | @raise Invalid_argument if trying to create multiple prepared statements 100 | for the same SQL query in PostgreSQL. To avoid this, just create the 101 | prepared statement {e once only} and call it whenever needed, as shown 102 | above. *) 103 | 104 | val exec_script : db -> string -> unit 105 | (** [exec_script db sql] executes the [sql] script (possibly made up of multiple 106 | statements) in the database [db]. Note that it ignores any rows returned by 107 | any of the statements. 108 | 109 | The script {i must not} have a trailing semicolon. *) 110 | 111 | (** {2 Binding arguments} 112 | 113 | These encode OCaml data as data to be bound to the query statement. *) 114 | 115 | module Arg : sig 116 | val text : string -> arg 117 | val bool : bool -> arg 118 | val int : int -> arg 119 | val nativeint : nativeint -> arg 120 | val int32 : int32 -> arg 121 | val int64 : int64 -> arg 122 | val float : float -> arg 123 | val blob : string -> arg 124 | 125 | val opt : ('a -> arg) -> 'a option -> arg 126 | (** [opt data value] is the optional [value] encoded as query data. *) 127 | end 128 | 129 | (** {3 Helpers to get typed values from columns} *) 130 | 131 | val int : int -> row -> int 132 | val bool : int -> row -> bool 133 | val int64 : int -> row -> int64 134 | val float : int -> row -> float 135 | 136 | val text : int -> row -> string 137 | (** Also handles values of all other types. Use this when SQLite can change the 138 | exact type of value it returns at runtime, e.g. for very large numbers it 139 | can return text. *) 140 | 141 | val opt : (int -> row -> 'a) -> int -> row -> 'a option 142 | (** [opt dec col row] is the optional value [NULL] turns to [None] at column 143 | [col] of the result [row]. *) 144 | end 145 | 146 | (** Utilities defined in terms of the common shared interface of a database. *) 147 | module type S = sig 148 | (** {2 Higher-level utilities that work across supported DBs} *) 149 | 150 | type db 151 | type arg 152 | 153 | exception Bad_migration of string 154 | 155 | val migrate : db -> string -> unit 156 | (** [migrate db dir] applies the SQL migration scripts in [dir] on the given 157 | database [db], keeping track of those that have already been applied. 158 | 159 | To apply the migrations in the correct order, the migration scripts must be 160 | given filenames that are sorted in lexicographical order of the desired 161 | migration order, e.g. [0000_0001_init.sql] will be applied before 162 | [0000_0002_sec.sql], and so on. 163 | 164 | Note that this uses [exec_script] internally, which means the migration 165 | scripts {i must not} have trailing semicolons either. 166 | 167 | Any files with extensions other than [.sql] are ignored. 168 | 169 | @raise Bad_migration an error occurs during applying the migrations. *) 170 | 171 | val transaction : db -> (unit -> 'r) -> 'r 172 | (** [transaction db f] runs [f ()] inside a transaction in the [db]. If the 173 | operation succeeds, it commits the transaction and returns its result. If it 174 | fails with an exception, it rolls back the transaction and re-raises the 175 | exception. *) 176 | end 177 | 178 | module Make (Sql : Sql) : S with type db = Sql.db and type arg = Sql.arg = 179 | struct 180 | type db = Sql.db 181 | type arg = Sql.arg 182 | 183 | open Sql 184 | 185 | let transaction db f = 186 | query db "begin" [] Query.unit; 187 | match f () with 188 | | r -> 189 | query db "commit" [] Query.unit; 190 | r 191 | | exception e -> 192 | query db "rollback" [] Query.unit; 193 | raise e 194 | 195 | let slurp file = 196 | let inc = open_in file in 197 | Fun.protect 198 | ~finally:(fun () -> close_in inc) 199 | (fun () -> really_input_string inc (in_channel_length inc)) 200 | 201 | exception Bad_migration of string 202 | 203 | let migrate db = 204 | exec_script db 205 | "create table if not exists migration ( 206 | filename varchar(1024) not null primary key, 207 | script text not null, 208 | applied_at timestamp 209 | )"; 210 | let mark_ok = 211 | query db 212 | (Query.sql 213 | "insert into migration (filename, script, applied_at) 214 | values (%a, %a, current_timestamp)" 215 | placeholder 0 placeholder 1) 216 | in 217 | let migrated = 218 | query db 219 | (Query.sql "select 1 from migration where filename = %a" placeholder 0) 220 | in 221 | let migrated filename = 222 | 0 223 | |> bool 224 | |> Query.ret 225 | |> migrated [filename] 226 | |> Query.one 227 | |> Option.fold ~none:false ~some:Fun.id 228 | in 229 | fun dir -> 230 | let files = Sys.readdir dir in 231 | Array.sort compare files; 232 | transaction db @@ fun () -> 233 | files 234 | |> Array.iter @@ fun filename -> 235 | let filename = dir ^ "/" ^ filename in 236 | let arg_filename = Arg.text filename in 237 | if 238 | String.ends_with ~suffix:".sql" filename 239 | && not (migrated arg_filename) 240 | then 241 | let script = slurp filename in 242 | match exec_script db script with 243 | | () -> mark_ok Arg.[arg_filename; text script] Query.unit 244 | | exception Failure msg -> raise (Bad_migration msg) 245 | end 246 | -------------------------------------------------------------------------------- /fun_sqlite/dune: -------------------------------------------------------------------------------- 1 | (library 2 | (name fun_sqlite) 3 | (public_name fun-sqlite) 4 | (libraries fun-sql sqlite3)) 5 | -------------------------------------------------------------------------------- /fun_sqlite/fun_sqlite.ml: -------------------------------------------------------------------------------- 1 | (* Copyright 2024 Yawar Amin 2 | 3 | This file is part of fun-sql. 4 | 5 | fun-sql is free software: you can redistribute it and/or modify it under the 6 | terms of the GNU General Public License as published by the Free Software 7 | Foundation, either version 3 of the License, or (at your option) any later 8 | version. 9 | 10 | fun-sql is distributed in the hope that it will be useful, but WITHOUT ANY 11 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 12 | A PARTICULAR PURPOSE. See the GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License along with 15 | fun-sql. If not, see . *) 16 | 17 | include Impl 18 | include Fun_sql.Make (Impl) 19 | 20 | (* We have to parse the value tuple of the insert statement to be able to 21 | multiply it a number of times if needed for a batch insert. *) 22 | 23 | let sp_r = Str.regexp " +" 24 | 25 | let wsp_r = 26 | Str.regexp 27 | @@ Printf.sprintf "[%c%c%c]+" (Char.chr 9) (Char.chr 10) (Char.chr 13) 28 | 29 | let values_r = 30 | Str.regexp_case_fold {|^\(insert into .* values *\)\(([^)]+)\)\(.*\)$|} 31 | 32 | let pre_pos = 1 33 | let tuple_pos = 2 34 | let post_pos = 3 35 | 36 | let batch_insert db sql objs obj_args = 37 | let sql = 38 | sql 39 | |> String.trim 40 | |> Str.global_replace wsp_r " " 41 | |> Str.global_replace sp_r " " 42 | in 43 | if Str.string_match values_r sql 0 then 44 | let tuple = Str.matched_group tuple_pos sql in 45 | let tuples = objs |> List.map (fun _ -> tuple) |> String.concat "," in 46 | let sql = 47 | Str.matched_group pre_pos sql ^ tuples ^ Str.matched_group post_pos sql 48 | in 49 | query db sql (objs |> List.map obj_args |> List.flatten) 50 | else 51 | failwith sql 52 | -------------------------------------------------------------------------------- /fun_sqlite/fun_sqlite.mli: -------------------------------------------------------------------------------- 1 | (* Copyright 2022 Yawar Amin 2 | 3 | This file is part of fun-sql. 4 | 5 | fun-sql is free software: you can redistribute it and/or modify it under the 6 | terms of the GNU General Public License as published by the Free Software 7 | Foundation, either version 3 of the License, or (at your option) any later 8 | version. 9 | 10 | fun-sql is distributed in the hope that it will be useful, but WITHOUT ANY 11 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 12 | A PARTICULAR PURPOSE. See the GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License along with 15 | fun-sql. If not, see . *) 16 | 17 | (** Use this module for SQLite database queries. *) 18 | 19 | include 20 | Fun_sql.Query_sig with type ('row, 'r) ret = ('row, 'r) Fun_sql.Query.ret 21 | 22 | include 23 | Fun_sql.Sql 24 | with type db = Sqlite3.db 25 | and type arg = Sqlite3.Data.t 26 | and type row = Sqlite3.Data.t array 27 | 28 | include Fun_sql.S with type db := db and type arg := arg 29 | 30 | val batch_insert : 31 | db -> string -> 'a list -> ('a -> arg list) -> (row, 'r) ret -> 'r 32 | (** [batch_insert db sql objs obj_args ret] inserts into the database [db], 33 | running the query [sql], the row tuples obtained by encoding the list of 34 | [objs] using the [obj_args] function. 35 | 36 | This prepares a new statement each time because the [VALUES (...)] clause 37 | may contain different numbers of placeholders in each call. 38 | 39 | The return type of the query is decoded by [ret]. *) 40 | -------------------------------------------------------------------------------- /fun_sqlite/impl.ml: -------------------------------------------------------------------------------- 1 | (* Copyright 2022 Yawar Amin 2 | 3 | This file is part of fun-sql. 4 | 5 | fun-sql is free software: you can redistribute it and/or modify it under the 6 | terms of the GNU General Public License as published by the Free Software 7 | Foundation, either version 3 of the License, or (at your option) any later 8 | version. 9 | 10 | fun-sql is distributed in the hope that it will be useful, but WITHOUT ANY 11 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 12 | A PARTICULAR PURPOSE. See the GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License along with 15 | fun-sql. If not, see . *) 16 | 17 | let placeholder f _ = Format.pp_print_char f '?' 18 | 19 | open Sqlite3 20 | 21 | type nonrec db = db 22 | type arg = Data.t 23 | type row = Data.t array 24 | 25 | include Fun_sql.Query 26 | 27 | let check_rc = function 28 | | Rc.OK | DONE -> () 29 | | rc -> failwith (Rc.to_string rc) 30 | 31 | let query : type r. db -> string -> arg list -> (row, r) ret -> r = 32 | fun db sql -> 33 | let stmt = prepare db sql in 34 | fun args -> 35 | ignore @@ reset stmt; 36 | (match args with 37 | | [] -> () 38 | | _ -> check_rc @@ bind_values stmt args); 39 | function 40 | | Unit -> 41 | check_rc @@ step stmt; 42 | check_rc @@ reset stmt 43 | | Ret decode -> 44 | let rows () = 45 | match step stmt with 46 | | ROW -> Some (stmt |> row_data |> decode, ()) 47 | | DONE -> None 48 | | rc -> failwith @@ Rc.to_string rc 49 | in 50 | Seq.unfold rows () 51 | 52 | let rec exec_script db attempts stmt = 53 | match step stmt, attempts with 54 | | Rc.BUSY, 0 -> failwith "busy" 55 | | BUSY, _ -> exec_script db (pred attempts) stmt 56 | | ROW, _ -> exec_script db attempts stmt 57 | | (DONE | OK), _ -> 58 | check_rc @@ finalize stmt; 59 | begin 60 | match prepare_tail stmt with 61 | | Some stmt -> exec_script db attempts stmt 62 | | None -> () 63 | end 64 | | rc, _ -> invalid_arg @@ Rc.to_string rc 65 | 66 | let exec_script db sql = exec_script db 3 @@ prepare db sql 67 | 68 | module Arg = struct 69 | let text value = Data.TEXT value 70 | let bool value = Data.INT (if value then 1L else 0L) 71 | let int value = Data.INT (Int64.of_int value) 72 | let nativeint value = Data.INT (Int64.of_nativeint value) 73 | let int32 value = Data.INT (Int64.of_int32 value) 74 | let int64 value = Data.INT value 75 | let float value = Data.FLOAT value 76 | let blob value = Data.TEXT value 77 | 78 | let opt data = function 79 | | Some value -> data value 80 | | None -> Data.NULL 81 | end 82 | 83 | let int64 pos row = 84 | match row.(pos) with 85 | | Data.INT value -> value 86 | | _ -> failwith "Expected int" 87 | 88 | let int pos row = Int64.to_int @@ int64 pos row 89 | let bool pos row = Int64.compare (int64 pos row) Int64.zero > 0 90 | 91 | let float pos row = 92 | match row.(pos) with 93 | | Data.FLOAT value -> value 94 | | _ -> failwith "Expected float" 95 | 96 | let text pos row = 97 | match row.(pos) with 98 | | Data.INT value -> Int64.to_string value 99 | | FLOAT value -> string_of_float value 100 | | BLOB value | TEXT value -> value 101 | | _ -> failwith "Expected text" 102 | 103 | let opt dec col row = 104 | match row.(col) with 105 | | Data.NULL -> None 106 | | _ -> Some (dec col row) 107 | -------------------------------------------------------------------------------- /ppx/dune: -------------------------------------------------------------------------------- 1 | (library 2 | (name ppx_deriving_funsql) 3 | (public_name ppx_deriving_funsql) 4 | (kind ppx_deriver) 5 | (libraries ppxlib)) 6 | -------------------------------------------------------------------------------- /ppx/ppx_deriving_funsql.ml: -------------------------------------------------------------------------------- 1 | open Ppxlib 2 | module List = ListLabels 3 | open Ast_builder.Default 4 | 5 | let row = "row" 6 | 7 | let rec typ ~loc fname = function 8 | | { ptyp_desc = 9 | Ptyp_constr 10 | ( { txt = Lident (("int" | "bool" | "int64" | "float") as name); _ }, 11 | [] ); 12 | _ 13 | } -> 14 | (* The ret decoder function has the same name as the type *) 15 | evar ~loc name 16 | | { ptyp_desc = Ptyp_constr ({ txt = Lident "string"; _ }, []); _ } -> 17 | (* The string decoder is called 'text' *) 18 | evar ~loc "text" 19 | | { ptyp_desc = 20 | (* The type is like M.t or _ M.t or (_, _) M.t and so on *) 21 | Ptyp_constr ({ txt = Ldot ((Lident _ as modident), "t"); _ }, _); 22 | _ 23 | } -> 24 | (* Eg: fun i row -> M.of_string (text i row) *) 25 | eabstract ~loc 26 | [pvar ~loc "i"; pvar ~loc row] 27 | (eapply ~loc 28 | (pexp_ident ~loc { loc; txt = Ldot (modident, "of_string") }) 29 | [eapply ~loc (evar ~loc "text") [evar ~loc "i"; evar ~loc row]]) 30 | | { ptyp_desc = Ptyp_constr ({ txt = Lident "option"; _ }, [opt_type]); _ } -> 31 | (* Eg: type is string option, decoder func is 'opt text' *) 32 | eapply ~loc (evar ~loc "opt") [typ ~loc fname opt_type] 33 | | _ -> failwith ("Cannot derive type for field: " ^ fname) 34 | 35 | let field_impl i ld = 36 | let loc = ld.pld_loc in 37 | let fieldname = ld.pld_name.txt in 38 | (* fieldname = typ i row *) 39 | ( { txt = Lident fieldname; loc }, 40 | eapply ~loc (typ ~loc fieldname ld.pld_type) [eint ~loc i; evar ~loc row] ) 41 | 42 | let generate_impl ~ctxt (_rec_flag, type_declarations) = 43 | let loc = Expansion_context.Deriver.derived_item_loc ctxt in 44 | List.map type_declarations ~f:(fun (td : type_declaration) -> 45 | [ (match td with 46 | | { ptype_kind = Ptype_abstract | Ptype_variant _ | Ptype_open; 47 | ptype_loc; 48 | _ 49 | } -> 50 | let ext = 51 | Location.error_extensionf ~loc:ptype_loc 52 | "Cannot derive accessors for non-record types" 53 | in 54 | pstr_extension ~loc ext [] 55 | | { ptype_kind = Ptype_record fields; _ } -> ( 56 | (* let ret = ret (fun row -> { ... }) *) 57 | try 58 | pstr_value ~loc Nonrecursive 59 | [ value_binding ~loc 60 | ~pat:(ppat_var ~loc { loc; txt = "ret" }) 61 | ~expr: 62 | (eapply ~loc (evar ~loc "ret") 63 | [ eabstract ~loc 64 | [ppat_var ~loc { txt = row; loc }] 65 | (pexp_record ~loc 66 | (List.mapi fields ~f:field_impl) 67 | None) ]) ] 68 | with Failure msg -> 69 | pstr_extension ~loc (Location.error_extensionf ~loc "%s" msg) [])) 70 | ]) 71 | |> List.concat 72 | 73 | let str_type_decl = Deriving.Generator.V2.make_noarg generate_impl 74 | let _ = Deriving.add ~str_type_decl "funsql" 75 | -------------------------------------------------------------------------------- /ppx/ppx_deriving_funsql.mli: -------------------------------------------------------------------------------- 1 | (** This is the PPX deriver for fun-sql. You won't use this module directly but 2 | as a part of your build. See the project 3 | {{: https://github.com/yawaramin/fun-sql?tab=readme-ov-file#ppx} readme} for 4 | details. *) 5 | -------------------------------------------------------------------------------- /ppx_deriving_funsql.opam: -------------------------------------------------------------------------------- 1 | # This file is generated by dune, edit dune-project instead 2 | opam-version: "2.0" 3 | version: "v0.4.0" 4 | synopsis: "PPX deriver for query row decoding into OCaml types" 5 | description: 6 | "This is a convenience PPX that takes care of the boilerplate of writing the conversion from query result rows to OCaml types." 7 | maintainer: ["Yawar Amin "] 8 | authors: ["Yawar Amin "] 9 | license: "GPL-3.0-or-later" 10 | tags: ["org:yawaramin" "fun-sql"] 11 | homepage: "https://github.com/yawaramin/fun-sql" 12 | doc: "https://yawaramin.github.io/fun-sql/" 13 | bug-reports: "https://github.com/yawaramin/fun-sql/issues" 14 | depends: [ 15 | "dune" {>= "2.7"} 16 | "ppxlib" {>= "0.32.1" & < "1.0.0"} 17 | "odoc" {with-doc} 18 | ] 19 | build: [ 20 | ["dune" "subst"] {dev} 21 | [ 22 | "dune" 23 | "build" 24 | "-p" 25 | name 26 | "-j" 27 | jobs 28 | "@install" 29 | "@runtest" {with-test} 30 | "@doc" {with-doc} 31 | ] 32 | ] 33 | dev-repo: "git+https://github.com/yawaramin/fun-sql.git" 34 | -------------------------------------------------------------------------------- /test_fun_postgresql/dune: -------------------------------------------------------------------------------- 1 | (test 2 | (name test_fun_postgresql) 3 | (package fun-postgresql) 4 | (libraries fun-postgresql) 5 | (action 6 | (diff test_fun_postgresql.expected.stdout test_fun_postgresql.stdout))) 7 | 8 | (rule 9 | (with-stdout-to 10 | test_fun_postgresql.stdout 11 | (run ./test_fun_postgresql.exe))) 12 | -------------------------------------------------------------------------------- /test_fun_postgresql/test_fun_postgresql.expected.stdout: -------------------------------------------------------------------------------- 1 | test_arg: blob: world 2 | test_arg: bool: false 3 | test_arg: float: 1.000000 4 | test_arg: int: 1 5 | test_arg: int32: 1 6 | test_arg: int64: 1 7 | test_arg: nativeint: 1 8 | test_arg: opt int: 9 | test_arg: text: hello 10 | test_row: hello true 1.000000 1 1 hello 11 | -------------------------------------------------------------------------------- /test_fun_postgresql/test_fun_postgresql.ml: -------------------------------------------------------------------------------- 1 | let test_arg msg arg = Printf.printf "test_arg: %s: %s 2 | " msg arg 3 | 4 | open Fun_postgresql 5 | 6 | let row = 7 | Arg.[|blob "hello"; bool true; float 1.; int 1; int64 1L; text "hello"|] 8 | 9 | let () = 10 | test_arg "blob" (Arg.blob "world"); 11 | test_arg "bool" (Arg.bool false); 12 | test_arg "float" (Arg.float 1.); 13 | test_arg "int" (Arg.int 1); 14 | test_arg "int32" (Arg.int32 1l); 15 | test_arg "int64" (Arg.int64 1L); 16 | test_arg "nativeint" (Arg.nativeint 1n); 17 | test_arg "opt int" Arg.(opt int None); 18 | test_arg "text" (Arg.text "hello"); 19 | 20 | Printf.printf "test_row: %s %b %f %d %Ld %s 21 | " (text 0 row) (bool 1 row) 22 | (float 2 row) (int 3 row) (int64 4 row) (text 5 row) 23 | -------------------------------------------------------------------------------- /test_fun_sqlite/dune: -------------------------------------------------------------------------------- 1 | (test 2 | (name test_fun_sqlite) 3 | (package fun-sqlite) 4 | (libraries fun-sqlite) 5 | (action 6 | (diff test_fun_sqlite.expected.stdout test_fun_sqlite.stdout))) 7 | 8 | (rule 9 | (with-stdout-to 10 | test_fun_sqlite.stdout 11 | (run ./test_fun_sqlite.exe))) 12 | -------------------------------------------------------------------------------- /test_fun_sqlite/test_fun_sqlite.expected.stdout: -------------------------------------------------------------------------------- 1 | test_arg: blob: TEXT <"world"> 2 | test_arg: bool: INT <0> 3 | test_arg: float: FLOAT <1.000000> 4 | test_arg: int: INT <1> 5 | test_arg: int32: INT <1> 6 | test_arg: int64: INT <1> 7 | test_arg: nativeint: INT <1> 8 | test_arg: opt int: NULL 9 | test_arg: text: TEXT <"hello"> 10 | test_row: hello true 1.000000 1 1 hello 11 | -------------------------------------------------------------------------------- /test_fun_sqlite/test_fun_sqlite.ml: -------------------------------------------------------------------------------- 1 | let test_arg msg arg = 2 | Printf.printf "test_arg: %s: %s 3 | " msg (Sqlite3.Data.to_string_debug arg) 4 | 5 | open Fun_sqlite 6 | 7 | let row = 8 | Arg.[|blob "hello"; bool true; float 1.; int 1; int64 1L; text "hello"|] 9 | 10 | let () = 11 | test_arg "blob" (Arg.blob "world"); 12 | test_arg "bool" (Arg.bool false); 13 | test_arg "float" (Arg.float 1.); 14 | test_arg "int" (Arg.int 1); 15 | test_arg "int32" (Arg.int32 1l); 16 | test_arg "int64" (Arg.int64 1L); 17 | test_arg "nativeint" (Arg.nativeint 1n); 18 | test_arg "opt int" Arg.(opt int None); 19 | test_arg "text" (Arg.text "hello"); 20 | 21 | Printf.printf "test_row: %s %b %f %d %Ld %s 22 | " (text 0 row) (bool 1 row) 23 | (float 2 row) (int 3 row) (int64 4 row) (text 5 row) 24 | -------------------------------------------------------------------------------- /test_ppx/dune: -------------------------------------------------------------------------------- 1 | (executable 2 | (name test_ppx) 3 | (modules test_ppx) 4 | (libraries ppx_deriving_funsql)) 5 | 6 | (rule 7 | (deps test.ml) 8 | (targets test.actual.ml) 9 | (action 10 | (run ./test_ppx.exe -o %{targets} %{deps}))) 11 | 12 | (test 13 | (name test) 14 | (modules test) 15 | (package ppx_deriving_funsql) 16 | (libraries fun-sqlite) 17 | (action 18 | (diff test.expected.ml test.actual.ml))) 19 | -------------------------------------------------------------------------------- /test_ppx/test.expected.ml: -------------------------------------------------------------------------------- 1 | open! Fun_sqlite 2 | type t = { 3 | name: string ; 4 | age: int option ; 5 | height_m: float }[@@deriving funsql] 6 | include 7 | struct 8 | let _ = fun (_ : t) -> () 9 | let ret = 10 | ret 11 | (fun row -> 12 | { 13 | name = (text 0 row); 14 | age = (opt int 1 row); 15 | height_m = (float 2 row) 16 | }) 17 | let _ = ret 18 | end[@@ocaml.doc "@inline"][@@merlin.hide ] 19 | -------------------------------------------------------------------------------- /test_ppx/test.ml: -------------------------------------------------------------------------------- 1 | open! Fun_sqlite 2 | 3 | type t = 4 | { name : string; 5 | age : int option; 6 | height_m : float 7 | } 8 | [@@deriving funsql] 9 | -------------------------------------------------------------------------------- /test_ppx/test_ppx.ml: -------------------------------------------------------------------------------- 1 | let () = Ppxlib.Driver.standalone () 2 | --------------------------------------------------------------------------------