├── .gitignore ├── COPYING ├── COPYING.LESSER ├── README.md ├── project.clj └── src ├── com └── freiheit │ └── gae │ ├── datastore │ ├── datastore_access_dsl.clj │ ├── datastore_query_dsl.clj │ ├── datastore_types.clj │ ├── keys.clj │ └── transactions.clj │ └── local_dev.clj └── example └── com └── freiheit └── gae └── datastore └── example.clj /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | .lein* 3 | classes 4 | clj-gae-datastore-*.jar 5 | lib 6 | pom.xml 7 | target 8 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /COPYING.LESSER: -------------------------------------------------------------------------------- 1 | GNU LESSER 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 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | About clj-gae-datastore 2 | ======================= 3 | 4 | This library provides an easy bridge between Clojure datastructures (structs) 5 | and the Google App Engine datastore by generating all the boilerplate code needed 6 | to access the datastore. For example, to create a simple book database just define your 7 | data as follows: 8 | 9 | (defentity book 10 | [:key] 11 | [:title] 12 | [:author] 13 | [:publisher] 14 | [:isbn] 15 | [:pages] 16 | [:outofprint 17 | :pre-save #(= % "yes") 18 | :post-load #(if % 19 | "yes" 20 | "no")]) 21 | 22 | Storing Data 23 | ------------ 24 | 25 | Storing a book in the datastore can be done via `store-entities!`. 26 | 27 | com.freiheit.gae.datastore.example> (store-entities! [(make-book :title "Paradigms of Artificial Intelligence Programming: Case Studies in Common Lisp" 28 | :author "Peter Norvig" 29 | :publisher "Morgan Kaufmann" 30 | :isbn "978-1558601918" 31 | :pages 946 32 | :outofprint "no")]) 33 | result: 34 | 35 | ({:outofprint "no", :pages 946, :isbn "978-1558601918", :publisher "Morgan Kaufmann", :author "Peter Norvig", :title "Paradigms of Artificial Intelligence Programming: Case Studies in Common Lisp", :key #, :parent-key nil, :kind "book"}) 36 | 37 | Querying the Datastore 38 | ---------------------- 39 | 40 | The data can be queried via a very simple query language that is also provided in the 41 | library. To find all books by a certain author just use the following code: 42 | 43 | com.freiheit.gae.datastore.example> (select (where book ([= :author "Peter Norvig"]))) 44 | 45 | result: 46 | 47 | ({:outofprint "no", :pages 946, :isbn "978-1558601918", :publisher "Morgan Kaufmann", :author "Peter Norvig", :title "Paradigms of Artificial Intelligence Programming: Case Studies in Common Lisp", :key #, :parent-key nil, :kind "book"}) 48 | 49 | Changing Data in the Datastore 50 | ------------------------------ 51 | 52 | Of course you need to able to change data that is already in the datastore. The API contains a function called `assoc-entity` that can be used to change the values of an entity. It also does some bookkeeping that marks an entity as changed. Please note that `assoc-entity` doesn't change the entity in the datastore. This is done with `update-entities!`. 53 | 54 | com.freiheit.gae.datastore.example> (let [book (first (select (where book ([= :author "Peter Norvig"])))) 55 | unavailable-book (assoc-entity book :outofprint "yes")] 56 | (update-entities! [unavailable-book])) 57 | 58 | result: 59 | 60 | ({:outofprint "yes", :pages 946, :isbn "978-1558601918", :publisher "Morgan Kaufmann", :author "Peter Norvig", :title "Paradigms of Artificial Intelligence Programming: Case Studies in Common Lisp", :key #, :parent-key nil, :kind "book"}) 61 | 62 | Deleting Data in the Datastore 63 | ------------------------------ 64 | 65 | Data that needs to be deleted in the datastore is identified by its key. So, in order to delete all books in the datastore just get the keys of all books in the datastore and call `delete-all!`. 66 | 67 | com.freiheit.gae.datastore.example> (let [keys (map :key (select (where book [])))] 68 | (delete-all! keys)) 69 | 70 | result: 71 | 72 | () 73 | 74 | A query for all books verifies that indeed all entities are removed from the datastore: 75 | 76 | com.freiheit.gae.datastore.example> (select (where book [])) 77 | 78 | result: 79 | 80 | () 81 | 82 | I need to try this! 83 | =================== 84 | 85 | A quick way to play with the library is from an Emacs Clojure 86 | REPL. Clone the repository and put the following libraries into a 87 | directory `"lib"`. 88 | 89 | - clojure.jar 90 | - clojure-contrib.jar 91 | - joda-time-1.6.jar 92 | - some libraries from the Google App Engine SDK. You can use the small script "etc/copy-gae-libs.sh" to 93 | do this. 94 | - clj-datetime-bin-0.1.jar (this jar is already included in the lib directory) 95 | 96 | Open the `src/example/clojure/com/freiheit/gae/datastore/example.clj` file in Emacs and use 97 | swank-clojure-project to setup a Clojure session. Compile the 98 | file and execute (init-app-engine) in the REPL. Now you should be able to play with the examples. 99 | 100 | For more information about setting up Clojure, Emacs and Google App Engine have a look at our 101 | [blog post](http://www.hackers-with-attitude.com/2009/08/intertactive-programming-with-clojure.html). 102 | 103 | Please note that clj-gae-datastore is not yet working with Clojure >= 1.2.0. 104 | 105 | Creating a library 106 | ================== 107 | 108 | Just type `ant jar` to create a jar file of the datastore library. 109 | 110 | If you want to create a jar of the compiled files type "ant binary-jar". This should be done after copying 111 | the dependent jar files into `"lib"` (see above.) 112 | 113 | Generate API documentation 114 | ========================== 115 | 116 | You can generate API documentation by typing `ant doc`. It will be available in `target/docs/api.html`. 117 | -------------------------------------------------------------------------------- /project.clj: -------------------------------------------------------------------------------- 1 | (defproject clj-gae-datastore "0.5" 2 | :description "clojure dsl for accessing the appengine datastore" 3 | :dependencies [[clj-time "0.4.0"] 4 | [com.google.appengine/appengine-api-1.0-sdk "1.7.0"] 5 | [com.google.appengine/appengine-api-labs "1.7.0"] 6 | [com.google.appengine/appengine-api-stubs "1.7.0"] 7 | [compojure "1.1.3"] 8 | [hiccup "1.0.1"] 9 | [org.clojure/clojure "1.4.0"] 10 | [org.clojure/tools.logging "0.2.4"] 11 | [ring/ring-core "1.1.5" :exclusions [[org.clojure/clojure-contrib]]] 12 | [ring/ring-devel "1.1.5"]] 13 | :profiles {:dev {:dependencies [[com.google.appengine/appengine-local-runtime "1.7.0"] 14 | [ring/ring-jetty-adapter "1.1.5"]]}}) 15 | -------------------------------------------------------------------------------- /src/com/freiheit/gae/datastore/datastore_access_dsl.clj: -------------------------------------------------------------------------------- 1 | ;; Copyright (c) 2010 freiheit.com technologies gmbh 2 | ;; 3 | ;; This file is part of clj-gae-datastore. 4 | ;; clj-gae-datastore is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU Lesser General Public License as published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; clj-gae-datastore is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU Lesser General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU Lesser General Public License 15 | ;; along with clj-gae-datastore. If not, see . 16 | 17 | (ns com.freiheit.gae.datastore.datastore-access-dsl 18 | #^{:doc "A mini-language to access the Google AppEngine datastore."} 19 | (:use 20 | [com.freiheit.gae.datastore.datastore-query-dsl :only [to-entity translate-to-datastore translate-from-datastore entity-to-map]]) 21 | (:require 22 | [com.freiheit.gae.datastore.transactions :as transactions]) 23 | (:import 24 | [com.google.appengine.api.datastore DatastoreServiceFactory Entity Key KeyFactory])) 25 | 26 | ;;;; Clojure and the Google App Engine Datastore are a perfect fit. With the low-level API 27 | ;;;; you can almost directly store Clojure datastructures natively into the datastore. 28 | ;;;; To use the low-level API, we put some simple abstractions on top of it. This way the 29 | ;;;; access to the datastore feels more lispy. 30 | 31 | ;;;; These definitions are needed to understand the code: 32 | 33 | ;;;; * Entity: An Entity is a record or a struct of data that is stored in the GAE datastore. 34 | 35 | ;;;; * Variable and Parameter naming: 36 | ;;;; When we use "entity", we always mean objects of the GAE class Entity 37 | ;;;; When we use "entity-map" we always mean a Clojure map which can be converted 38 | ;;;; to an "entity", because it was defined with defentity and is maintained by the 39 | ;;;; functions and macros of this package. 40 | 41 | 42 | ;;;; * Translate: In Clojure you can use normal structs. Before you can store a struct into the 43 | ;;;; GAE datastore, it has to be translated, because the datastore can only handle 44 | ;;;; a fixed set of datastructures. If you want to store an instance of a type which is not supported 45 | ;;;; by the datastore, you have to translate it to a supported datatype. Example: If 46 | ;;;; you want to store java.util.Date (which is a supported type, but just to give you an easy example), 47 | ;;;; you might want to translate it into Millis (long) before saving it (pre-save). 48 | ;;;; When you retrieve it from the datastore (post-load), you have to translate it back from Millis to 49 | ;;;; java.util.Date. So in this file, the word "translation" has nothing to do with I18N etc. 50 | 51 | ;;;; We made it really easy to define such translations. You just use the Macro defentity. 52 | ;;;; It takes a list of clauses. Each clause contains an attribute-name and (optional) options. 53 | 54 | ;;;; Valid options are: 55 | ;;;; Name Value Description 56 | ;;;; :pre-save a function Called for this attribute before an entity is saved to the datastore 57 | ;;;; Default is the identity function 58 | ;;;; :post-load a function Called for this attribute after an entity is loaded from the datastore 59 | ;;;; Default is the identity function 60 | ;;;; :unindexed boolean If true, this attribute is not indexed. If false, it will be indexed. 61 | ;;;; Default is false. This means the attribute will be indexed if the GAE type 62 | ;;;; supports indexing. 63 | 64 | ;;;; Under the hood we generate two multimethods (translate-to-datastore, translate-from-datastore) for 65 | ;;;; each defentity definition, which specialize on the kind of an entity/entity-map. These multimethods 66 | ;;;; are used to by this system to call your pre-save and post-load functions. 67 | ;;;; Check out the macro defentity for how they are generated. 68 | 69 | ;;;; You should not use these multimethods in you programs, but you can use them for debugging purposes: 70 | 71 | (comment 72 | (translate-from-datastore ) ; DON'T RELY ON THIS IN YOU CODE. IT MIGHT CHANGE! 73 | (translate-to-datastore )) ; SHOULD ONLY BE USED BY THIS PACKAGE! 74 | 75 | 76 | ;;;; An entity is processed in the following steps: 77 | ;;;; 78 | ;;;; Loading from the datastore: 79 | ;;;; datastore -> load -> translate-attributes -> translate entity (post-load) -> entity 80 | ;;;; 81 | ;;;; Storing in the datastore: 82 | ;;;; entity -> translate-entity (pre-save) -> translate attributes -> store -> datastore 83 | 84 | ;;;; We supplied some standard translations for the currently supported GAE datatypes, too. 85 | 86 | 87 | ;;;; Using defentity 88 | ;;;; --------------- 89 | 90 | ;;;; To define the schema of an entity, you use defentity. 91 | 92 | (comment 93 | "This defines an Entity named project, with two properties, :key and :title" 94 | (defentity project 95 | [:key] 96 | [:title :pre-save to-text :post-load from-text] 97 | :options [])) 98 | 99 | ;;;; CAUTION: Currently we don't evaluate the options-statement (see last line in the above example) 100 | 101 | ;;;; This creates the code to generate and convert objects of the GAE class Entity. This example 102 | ;;;; generates a function "make-project", which can be used to create entity-maps of the kind "project". 103 | 104 | ;;;; The following code creates an in-memory entity-map of the kind "project" with the attribute :title set 105 | ;;;; to "Project1". 106 | ;;;; Your entity-map is not saved to the datastore. 107 | 108 | (comment 109 | (make-project :title "Project1")) 110 | 111 | ;;;; If you want to convert this to an entity object you can call to-entity. This is a 112 | ;;;; multimethod that is generated by defentity and which "knows" how to generate 113 | ;;;; a GAE Entity of this kind. But you should never use it in your code. 114 | ;;;; You can use it for debugging. 115 | 116 | (comment 117 | (to-entity (make-project :title "Project1"))) ;DON'T RELY ON to-entity IN YOUR CODE. IT MIGHT CHANGE! 118 | 119 | ;;;; You NEVER work with entities (objects of class Entity) in your Clojure programs. 120 | ;;;; You should only work with entity-maps, which are standard Clojure struct-maps. 121 | 122 | ;;;; CHANGING DATA. 123 | ;;;; 124 | ;;;; Changing data in entity-maps should not be done directly via (assoc ...) but by using the 125 | ;;;; (assoc-and-track-changes ...) function. This keeps a log of changes in the meta-data 126 | ;;;; of the returned entity-map and can therefore be used to check if an entity-map needs 127 | ;;;; to be updated in the datastore. 128 | 129 | ;;;; If you want to save soemthing to the datastore, you are using the store!-function 130 | ;;;; You just hand-over an entity-map. The system converts this automatically to an entity 131 | ;;;; of the correct kind and stores that into the datastore. 132 | 133 | (comment 134 | (store! (make-project :title "Project1"))) 135 | 136 | ;;;; RELATIONSHIPS BETWEEN ENTITIES 137 | ;;;; 138 | ;;;; At the moment it's only possible to define parent-key relationships between entities. 139 | ;;;; Ex. 140 | ;;;; (def-parent-key-relationship project phase) 141 | ;;;; creates a function called (phases-for-project-id [project-key queries]) which can be used 142 | ;;;; to query the datastore for phases that are children of the given parent-key. 143 | ;;;; creates a function called (project-id-of-phase [phase]) which returns the id for a phase 144 | 145 | ;; ------------------------------------------------------------------------------ 146 | ;; private functions 147 | ;; ------------------------------------------------------------------------------ 148 | 149 | (defn- create-empty-entity 150 | "Create an empty entity in memory to be stored in the datastore. No attributes are set yet." 151 | ([#^Key key] 152 | (Entity. key)) 153 | ([#^String kind #^Key parent-key #^String key-name] 154 | (if parent-key 155 | (if key-name 156 | (Entity. kind key-name parent-key) 157 | (Entity. kind parent-key)) 158 | (if key-name 159 | (Entity. kind key-name) 160 | (Entity. kind))))) 161 | 162 | (defn- set-properties 163 | "Set the properties of the entity with the attributes of the item." 164 | [entity entity-map] 165 | (doseq [[prop-name value] (dissoc entity-map :key)] 166 | (let [unindexed (get-in (meta entity-map) [prop-name :unindexed])] 167 | ;;checking for false to work nicely with allow-dynamic since dynamic fields will be unindexed 168 | (if (= false unindexed) 169 | (.setProperty entity (name prop-name) value) 170 | (.setUnindexedProperty entity (name prop-name) value)))) 171 | entity) 172 | 173 | (defn- entitymap-to-new-entity 174 | "Converts an entity-map to an entity. Uses the key contained in the entity-map to 175 | construct a fresh new Entity to be stored for the first time in the datastore." 176 | [entity-map] 177 | (-> 178 | (create-empty-entity (:key entity-map)) 179 | (set-properties entity-map))) 180 | 181 | (defn- entitymap-to-entity 182 | [entity-map] 183 | "Converts an entity-map to an entity. When a key exists, don't create a new one! 184 | This means we create a fresh new entity, if the key is not already set. If we have 185 | a key, we keep it, so that the system will update the already existing data in the datastore." 186 | (if (:key entity-map) 187 | (entitymap-to-new-entity entity-map) 188 | (to-entity entity-map))) 189 | 190 | (defn- save-entity! 191 | "Save an entity to the datastore." 192 | [entity] 193 | (when-not (nil? entity) 194 | (.put (com.google.appengine.api.datastore.DatastoreServiceFactory/getDatastoreService) entity)) 195 | entity) 196 | 197 | (defn- save-entities! 198 | "Save a collection of entities to the datastore." 199 | [#^java.util.Collection entities] 200 | (when-not (empty? entities) 201 | (.put (com.google.appengine.api.datastore.DatastoreServiceFactory/getDatastoreService) entities)) 202 | entities) 203 | 204 | ;; ------------------------------------------------------------------------------ 205 | ;; parsing the access dsl (private, too!) 206 | ;; ------------------------------------------------------------------------------ 207 | 208 | (defn- field-clauses 209 | [clauses] 210 | (take-while vector? clauses)) 211 | 212 | (defn- option-clauses 213 | [clauses] 214 | (drop-while vector? clauses)) 215 | 216 | 217 | (defn- validate-field-option 218 | "Returns the option, if it is valid or throws and IllegalArgumentException" 219 | [option] 220 | (if (or (= option :pre-save) 221 | (= option :post-load) 222 | (= option :unindexed)) 223 | option 224 | (throw (IllegalArgumentException. 225 | (str "This option is not valid (Try :pre-save, :post-load or :unindexed instead): " option))))) 226 | 227 | 228 | (defn- destructure-field-clause 229 | "[:field :pre-save #pre-save-func :post-load #post-load-func :unindexed bool] 230 | --> {:attr-name :field, :pre-save #pre-save-func, :post-load #post-load-func :unindexed bool}" 231 | [clause] 232 | (if (and (> (count clause) 0) 233 | (odd? (count clause))) 234 | (let [mapped-clause {:attr-name (keyword (first clause))} 235 | options (partition 2 (rest clause))] 236 | (reduce (fn [left right] 237 | (assoc left (validate-field-option (keyword (first right))) (last right))) 238 | mapped-clause 239 | options)) 240 | (throw (IllegalArgumentException. 241 | (str "Malformed clause: " clause))))) 242 | 243 | 244 | (defn- transform-clauses 245 | "list of {:attr-name :field, :pre-save #pre-save-func, :post-load #post-load-func, :unindexed bool} 246 | --> list of {:field {:pre-save #pre-save-func, :post-load #post-load-func, :unindexed bool}}" 247 | [clauses] 248 | (map #(destructure-field-clause %) clauses)) 249 | 250 | (defn- build-fn-lookup-table 251 | "list of {:field {:pre-save #pre-save-func, :post-load #post-load-func, :unindexed bool}} 252 | --> one single hashmap of {:field1 {:pre-save #pre-save-func :post-load #post-load-func :unindexed bool}, ... :field2 {...}}" 253 | [clauses] 254 | (reduce (fn [left right] 255 | (assoc left (:attr-name right) (dissoc right :attr-name))) 256 | {} 257 | (transform-clauses (field-clauses clauses)))) 258 | 259 | 260 | (defn- build-allowed-keys 261 | "Creates a list of the keys that were defined with a call to defentity. 262 | We use it to check which keys from the map should be stored in the datastore 263 | to prevent the programmer from adding new properties accidentally." 264 | [clauses] 265 | (map first (field-clauses clauses))) 266 | 267 | 268 | (defn- get-conversion-fn 269 | "Get pre-save or post-load conversion function for attr-name" 270 | [func-name attr-name lookup-table] 271 | (get (get lookup-table attr-name) func-name identity)) 272 | 273 | (defn- get-unindexed 274 | "Get unindexed for attr-name" 275 | [attr-name lookup-table] 276 | (get (get lookup-table attr-name) :unindexed false)) 277 | 278 | (defn merge-with-translation 279 | [m entity translation-fns] 280 | (reduce (fn [m [key {:keys [translation unindexed]}]] 281 | (let [value (translation (get entity key)) 282 | meta-data (assoc (meta m) key {:unindexed unindexed})] 283 | (with-meta (assoc m key value) meta-data))) 284 | m translation-fns)) 285 | 286 | (defn- build-conversion-fn 287 | "Build the s-expr for a conversion function from a lookup table" 288 | [entity-sym kind keys func-name fn-lookup-table options-table] 289 | (let [translation-fns (reduce (fn [m key] (assoc m key {:translation (get-conversion-fn func-name key fn-lookup-table) 290 | :unindexed (get-unindexed key fn-lookup-table)})) {} keys)] 291 | (if (:allow-dynamic options-table) 292 | `(let [base-object# (assoc (into {} ~entity-sym) :kind ~kind)] 293 | (merge-with-translation base-object# ~entity-sym ~translation-fns)) 294 | `(merge-with-translation {:kind ~kind} ~entity-sym ~translation-fns)))) 295 | 296 | ;;; ------------------------------------------------------------------------------ 297 | ;;; public functions 298 | ;;; ------------------------------------------------------------------------------ 299 | 300 | (defn create-entity 301 | "Creates a new GAE Entity object from a clojure map. The Entity is created in memory and is not persisted. 302 | It is only used by the multimethod to-entity (which is generated by defentity) AND SHOULD NOT BE USED ELSEWHERE IN YOUR CODE. 303 | We leave it as a public function to make it easier for the programmer to create Entity objects for debugging purposes. 304 | But please do not rely on it!" 305 | ([#^String kind entity-map] (create-entity kind entity-map nil nil)) 306 | ([#^String kind entity-map #^Key parent-key] 307 | (create-entity kind entity-map parent-key nil)) 308 | ([#^String kind entity-map #^Key parent-key #^String keyName] 309 | (let [entity (create-empty-entity kind parent-key keyName)] 310 | (set-properties entity entity-map) 311 | entity))) 312 | 313 | 314 | (defn assoc-and-track-changes 315 | "Works exactly like assoc on a map, but does some book-keeping of the changes 316 | be storing the changes in the meta-data. This way we can check, if an entity 317 | changed and if we have to update it in the datastore, too. This even enables us to 318 | only send the changed properties to the datastore." 319 | ([entity-map & kvs] 320 | (with-meta (apply assoc entity-map kvs) (apply assoc {} kvs) ))) 321 | 322 | 323 | (defn has-changes? 324 | "Returns true when the entity-map has been changed by using the function assoc-and-track-changes 325 | and needs to be saved to the datastore. This won't detect changes, if you did not use 326 | assoc-and-track-changes and used assoc or something else instead to manipulate the entity-map." 327 | [entity-map] 328 | (not (empty? (meta entity-map)))) 329 | 330 | (defn changes 331 | "Returns only the changed key/values when the entity-map has been changed by using the function assoc-and-track-changes 332 | and needs to be saved to the datastore. This won't return changes, if you did not use 333 | assoc-and-track-changes and used assoc or something else instead to manipulate the entity-map." 334 | [entity-map] 335 | (meta entity-map)) 336 | 337 | 338 | ;; for serializing keys 339 | (defmethod print-dup com.google.appengine.api.datastore.Key 340 | [val writer] 341 | (.write writer (str "#=(com.google.appengine.api.datastore.KeyFactory/stringToKey \"" (KeyFactory/keyToString val) "\")"))) 342 | 343 | (defn set-parent-for-map 344 | "Get the parent for a struct map representing an in-memory-entity before storing to datastore." 345 | [parent-key m] 346 | (assoc m :parent-key parent-key)) 347 | 348 | (defn get-parent-for-map 349 | "Get the parent for a struct map representing an in-memory-entity before storing to datastore." 350 | [m] 351 | (:parent-key m)) 352 | 353 | (defmacro defentity 354 | "Define the schema for Google App Engine datastore entity. 355 | Syntax: (defentity [:attr-name1 :pre-save #fn :post-load fn :unindexed bool] [:attr-name2 ...]...)" 356 | [entity-name & body] 357 | (let [allowed-keys (build-allowed-keys body) 358 | fn-lookup-table (build-fn-lookup-table (take-while vector? body)) 359 | options-table (apply hash-map (remove vector? body)) 360 | selection-keys (vec (conj allowed-keys :parent-key)) 361 | ;FIXME: Better to store parent-key in meta-data! 362 | kind (str entity-name)] 363 | `(do 364 | (defstruct ~entity-name ~@allowed-keys) 365 | 366 | (defn ~(symbol (str "make-" (name entity-name))) 367 | [& inits#] 368 | (apply struct-map ~entity-name :kind ~kind inits#)) 369 | 370 | (defmethod translate-to-datastore ~kind 371 | [~entity-name] 372 | ~(if-let [entity-pre-save (:pre-save options-table)] 373 | `(let [~entity-name (~entity-pre-save ~entity-name)] 374 | ~(build-conversion-fn entity-name kind selection-keys :pre-save fn-lookup-table options-table)) 375 | (build-conversion-fn entity-name kind selection-keys :pre-save fn-lookup-table options-table))) 376 | 377 | (defmethod translate-from-datastore ~kind 378 | [~entity-name] 379 | ~(if-let [entity-post-load (:post-load options-table)] 380 | `(~entity-post-load 381 | ~(build-conversion-fn entity-name kind selection-keys :post-load fn-lookup-table options-table)) 382 | (build-conversion-fn entity-name kind selection-keys :post-load fn-lookup-table options-table))) 383 | 384 | (defmethod to-entity ~kind 385 | [~entity-name] 386 | ~(if (:allow-dynamic options-table) 387 | `(create-entity ~kind 388 | (with-meta (dissoc ~entity-name :parent-key :kind) (meta ~entity-name)) 389 | (get-parent-for-map ~entity-name)) 390 | `(create-entity ~kind 391 | (with-meta (select-keys ~entity-name (vector ~@allowed-keys)) (meta ~entity-name)) 392 | (get-parent-for-map ~entity-name))))))) 393 | 394 | 395 | ;; defining relationships 396 | (defmacro def-parent-key-relationship [parent child] 397 | (let [parent-id-sym (symbol (str parent "-id")) 398 | query-sym (symbol "queries")] 399 | `(do 400 | ;; ex: phases-for-release-id 401 | (defmacro ~(symbol (str child "s-for-" parent "-id")) 402 | [~parent-id-sym ~query-sym] 403 | `(when ~~parent-id-sym 404 | (com.freiheit.gae.datastore.datastore-query-dsl/select 405 | (com.freiheit.gae.datastore.datastore-query-dsl/where ~~parent-id-sym 406 | ~(quote ~child) 407 | ~~query-sym)))) 408 | ;; ex: release-id-of-phase 409 | (defn ~(symbol (str parent "-id-of-" child)) 410 | [~child] 411 | (if-let [child-key# (:key ~child)] 412 | (.getParent child-key#) 413 | (get-parent-for-map ~child))) 414 | ;; ex: make-phase-for-release-id 415 | (defn ~(symbol (str "make-" child "-for-" parent "-id")) 416 | [~parent-id-sym & inits#] 417 | (set-parent-for-map ~parent-id-sym (apply ~(symbol (str "make-" child)) inits#)))))) 418 | 419 | 420 | ;;; TODO: the store-functions should be consolidated into one single function 421 | 422 | (defn store-entities! 423 | "Store a list of entity-maps in the datastore." 424 | [entities] 425 | (->> entities 426 | (map translate-to-datastore) 427 | (map to-entity) 428 | (save-entities!) 429 | (map entity-to-map) 430 | (map translate-from-datastore))) 431 | 432 | (defn store-entity! 433 | "Store an entity-map in the datastore." 434 | [entity] 435 | (->> entity 436 | (translate-to-datastore) 437 | (to-entity) 438 | (save-entity!) 439 | (entity-to-map) 440 | (translate-from-datastore))) 441 | 442 | (defn update-entities! 443 | "Update a list of entity-maps in the datastore." 444 | [entities] 445 | (->> entities 446 | (map translate-to-datastore) 447 | (map entitymap-to-new-entity) ;entity-for-item 448 | (save-entities!) 449 | (map entity-to-map) 450 | (map translate-from-datastore))) 451 | 452 | (defn update-entity! 453 | "Update an entity-map in the datastore." 454 | [entity] 455 | (->> entity 456 | (translate-to-datastore) 457 | (entitymap-to-new-entity) ;entity-for-item 458 | (save-entity!) 459 | (entity-to-map) 460 | (translate-from-datastore))) 461 | 462 | (defn store-or-update-entities! 463 | "Update or save a list of entity-maps in the datastore." 464 | [entities] 465 | (->> entities 466 | (map translate-to-datastore) 467 | (map entitymap-to-entity) ;entity-for-item-when-existing 468 | (save-entities!) 469 | (map entity-to-map) 470 | (map translate-from-datastore))) 471 | 472 | (defn store-or-update-entity! 473 | "Update or save an entity-map in the datastore." 474 | [entity] 475 | (->> entity 476 | (translate-to-datastore) 477 | (entitymap-to-entity) ;entity-for-item-when-existing 478 | (save-entity!) 479 | (entity-to-map) 480 | (translate-from-datastore))) 481 | 482 | (defn delete-all! 483 | "Delete all entities specified by the given keys from the datastore." 484 | [#^java.util.Collection keys] 485 | (let [service (DatastoreServiceFactory/getDatastoreService) 486 | max-batch-size 500] 487 | (dorun 488 | (for [#^Key key-batch (partition-all max-batch-size keys)] 489 | (.delete service key-batch))))) 490 | 491 | (defn delete! 492 | "Delete all entities specified by the given keys from the datastore." 493 | [key] 494 | (let [service (DatastoreServiceFactory/getDatastoreService)] 495 | (.delete service [key]))) 496 | -------------------------------------------------------------------------------- /src/com/freiheit/gae/datastore/datastore_query_dsl.clj: -------------------------------------------------------------------------------- 1 | ;; Copyright (c) 2010 freiheit.com technologies gmbh 2 | ;; 3 | ;; This file is part of clj-gae-datastore. 4 | ;; clj-gae-datastore is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU Lesser General Public License as published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; clj-gae-datastore is distributed in the hope that it will be useful 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU Lesser General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU Lesser General Public License 15 | ;; along with clj-gae-datastore. If not, see . 16 | 17 | (ns com.freiheit.gae.datastore.datastore-query-dsl 18 | #^{:doc "A DSL for querying entities from the google datastore."} 19 | (:import 20 | [com.google.appengine.api.datastore 21 | DatastoreServiceFactory Entity Key KeyFactory Query Query$FilterOperator 22 | EntityNotFoundException FetchOptions FetchOptions$Builder Cursor])) 23 | 24 | ;;;; Querying entities from the google datastore. 25 | ;;;; Provides a query-language which can be used to 26 | ;;;; search for entities by search predicates. 27 | ;;;; 28 | ;;;; Examples: 29 | ;;;; 1 (select (where feature ([= :feature-title "Register user"]))) 30 | ;;;; this will select all features with a feature-title of "Register user". 31 | ;;;; 2 (select-only-keys (where feature ([= :feature-title "Register user"]))) 32 | ;;;; same as above but will only return the keys of the entities. This is 33 | ;;;; much faster than querying for whole entities. 34 | ;;;; 35 | ;;;; It's also possible to use '<', '<=', '>' or '>=' in the where clause. 36 | ;;;; 37 | ;;;; The returned entities are already translated by their corresponding translation function. 38 | ;;;; 39 | ;;;; 3 (resolve-entities (select (where feature ())) :feature-author-id) 40 | ;;;; returns a list of features (as in the example above) but replaces the feature-author-id 41 | ;;;; with the actual entities referenced in the entities' :feature-author-id attributes. 42 | ;;;; 43 | ;;;; this is done by first collecting all author ids in the list of features returned by 44 | ;;;; the select clause, and afterwards doing a "batch get" operation. this is more efficient 45 | ;;;; than doing single queries. 46 | 47 | ;; ------------------------------------------------------------------------------ 48 | ;; constants and data structures 49 | ;; ------------------------------------------------------------------------------ 50 | (defn- fetch-options 51 | "Create fetch options for a query with the given limit and an optional websafe cursor. 52 | The cursor is ignored if it is nil." 53 | ([#^Number limit] 54 | (fetch-options limit nil)) 55 | ([#^Number limit #^String cursor] 56 | (let [clamped-limit (if (> 100 limit) 100 limit) 57 | limit-options (doto (FetchOptions$Builder/withLimit limit) 58 | (.prefetchSize clamped-limit) 59 | (.chunkSize clamped-limit))] 60 | (if (nil? cursor) 61 | limit-options 62 | (->> (Cursor/fromWebSafeString cursor) 63 | (.cursor limit-options)))))) 64 | 65 | ;; ------------------------------------------------------------------------------ 66 | ;; private functions 67 | ;; ------------------------------------------------------------------------------ 68 | 69 | (defn- mapmap 70 | "Create a new map by applying key-f to every key and val-f to every value of a map" 71 | [key-f val-f m] 72 | (apply merge (map (fn [[k v]] {(key-f k) (val-f v)}) m))) 73 | 74 | (defn- execute-query 75 | "Execute the datastore query. Uses the default fetch options if none are given." 76 | ([#^Query query] 77 | (execute-query query (FetchOptions$Builder/withDefaults))) 78 | ([#^Query query #^FetchOptions fetch-options] 79 | (let [data-service (com.google.appengine.api.datastore.DatastoreServiceFactory/getDatastoreService) 80 | results (. (.prepare data-service query) asQueryResultList fetch-options)] 81 | results))) 82 | 83 | (defn- distinct-entity-keys 84 | "resolving an id property for a list of elements." 85 | [entities attr] 86 | (filter identity (distinct (mapcat #(let [ret (attr %)] 87 | (if (instance? java.util.Collection ret) 88 | ret 89 | [ret])) 90 | entities)))) 91 | 92 | (defn- translate-map-vals 93 | "Apply the given function to all values in the map." 94 | [m function] 95 | (mapmap identity function m)) 96 | 97 | (defn- replace-map-vals 98 | "." 99 | [m entities attr target-attr] 100 | (map (fn [entity] 101 | (assoc entity target-attr 102 | (let [entity-vals (attr entity)] 103 | (if (instance? java.util.Collection entity-vals) 104 | (vals (select-keys m (attr entity))) 105 | (get m entity-vals))))) entities)) 106 | 107 | (def mem-keyword (memoize keyword)) 108 | 109 | 110 | ;; ------------------------------------------------------------------------------ 111 | ;; public functions 112 | ;; ------------------------------------------------------------------------------ 113 | 114 | (defn entity-to-map 115 | "Converts an instance of com.google.appengine.api.datastore.Entity 116 | to a PersistentHashMap with properties stored under keyword keys 117 | plus the entity's kind stored under :kind and key stored under :key." 118 | [#^com.google.appengine.api.datastore.Entity entity] 119 | (reduce #(assoc %1 (mem-keyword (key %2)) (val %2)) 120 | {:kind (.getKind entity) :key (.getKey entity)} 121 | (.entrySet (.getProperties entity)))) 122 | 123 | (defn get-entity-by-key 124 | "Return a map of keys to entities for the given keys." 125 | [#^com.google.appengine.api.datastore.Key key] 126 | (.get (DatastoreServiceFactory/getDatastoreService) key)) 127 | 128 | (defn get-entities-by-keys 129 | "Return a map of keys to entities for the given keys." 130 | [#^java.util.Collection keys] 131 | (.get (DatastoreServiceFactory/getDatastoreService) keys)) 132 | 133 | ;; translation multi methods 134 | (defmulti translate-to-datastore 135 | "Multimethod for translating elements to the datastore. Dispatches on the kind." 136 | :kind) 137 | 138 | (defmulti translate-from-datastore 139 | "Multimethod for translating elements from the datastore. Dispatches on the kind." 140 | :kind) 141 | 142 | (defmulti to-entity 143 | "Multimethod for creating an entity. Dispatches on the kind." 144 | :kind) 145 | 146 | (defn translate-entities 147 | "Translate the attributes of entities with the translation functions from datastore to 148 | the actual domain model." 149 | [entities] 150 | (doall (map (comp translate-from-datastore entity-to-map) entities))) 151 | 152 | (defn translate-keys-only 153 | "Translate only the keys of the entities." 154 | [entities] 155 | (map (memfn getKey) entities)) 156 | 157 | (defn assert-cursor 158 | "Get the cursor if one was returned." 159 | [result] 160 | (if-let [cursor(.getCursor result)] 161 | (.toWebSafeString cursor) 162 | (throw (IllegalArgumentException. "Batch-Query didn't return a cursor (ie not-equal filter), use offset/limit instead.")))) 163 | 164 | (defn select 165 | "Executes the given com.google.appengine.api.datastore.Query 166 | and returns the results as a sequence of items converted with entity-to-map." 167 | [#^Query query] 168 | (doall (-> query 169 | execute-query 170 | translate-entities))) 171 | 172 | (defn select-only-keys 173 | "Executes the given com.google.appengine.api.datastore.Query 174 | and returns the result-keys." 175 | [#^Query query] 176 | (doall (-> query 177 | (.setKeysOnly) 178 | execute-query 179 | translate-keys-only))) 180 | 181 | (defn select-batch 182 | "Executes the given com.google.appengine.api.datastore.Query with a fetch options 183 | limit and an optional cursor information to resume a previous batch select. 184 | 185 | The return value is a map containing the query result list and a cursor to resume 186 | the query at the last postion." 187 | ([#^Query query #^Number limit] 188 | (select-batch query limit nil)) 189 | ([#^Query query #^Number limit #^String cursor] 190 | (let [query-result (->> (fetch-options limit cursor) 191 | (execute-query query))] 192 | {:result (translate-entities query-result) 193 | :cursor (assert-cursor query-result)}))) 194 | 195 | (defn select-only-keys-batch 196 | "Works similar to select-batch but returns the entities' keys as result." 197 | ([#^Query query #^Number limit] 198 | (select-only-keys-batch query limit nil)) 199 | ([#^Query query #^Number limit #^String cursor] 200 | (let [query-result (->> (fetch-options limit cursor) 201 | (execute-query (.setKeysOnly query)))] 202 | {:result (translate-keys-only query-result) 203 | :cursor (assert-cursor query-result)}))) 204 | 205 | (defmacro where 206 | "Create a query for a given kind. 207 | 208 | TODO: run the query-parameter-values through translate-to-datastore. 209 | 210 | When the kind is nil, then a kindless-query will be generated. 211 | 212 | Ex: (where person [[= :person-password-hash \"123\"]])" 213 | ([kind queries] 214 | `(where :none ~kind ~queries)) 215 | ([parent-key kind queries] 216 | (let [kindless? (nil? kind) 217 | op-smap {'= 'com.google.appengine.api.datastore.Query$FilterOperator/EQUAL 218 | 'not= 'com.google.appengine.api.datastore.Query$FilterOperator/NOT_EQUAL 219 | '< 'com.google.appengine.api.datastore.Query$FilterOperator/LESS_THAN 220 | '<= 'com.google.appengine.api.datastore.Query$FilterOperator/LESS_THAN_OR_EQUAL 221 | '> 'com.google.appengine.api.datastore.Query$FilterOperator/GREATER_THAN 222 | '>= 'com.google.appengine.api.datastore.Query$FilterOperator/GREATER_THAN_OR_EQUAL 223 | 'in 'com.google.appengine.api.datastore.Query$FilterOperator/IN} 224 | op-queries (map (fn [query] (replace op-smap query)) queries)] 225 | `(let [q# ~(if kindless? 226 | `(com.google.appengine.api.datastore.Query.) 227 | `(com.google.appengine.api.datastore.Query. ~(name kind)))] 228 | 229 | (cond 230 | (nil? ~parent-key) (throw (IllegalArgumentException. "Parent key cannot be nil, use :none instead.")) 231 | (not= :none ~parent-key) (.setAncestor q# ~parent-key)) 232 | 233 | (doseq [[operator# prop# value#] ~(vec op-queries)] 234 | (. q# addFilter (name prop#) (eval operator#) value#)) 235 | q#)))) 236 | 237 | (defmacro where-dyn-queries 238 | "Create a query for a given kind with dynamic query parameters. 239 | 240 | TODO: run the query-parameter-values through translate-to-datastore. 241 | 242 | Ex: (where-dyn-queries person [[:= :person-password-hash \"123\"]])" 243 | ([kind queries] 244 | `(where-dyn-queries nil ~kind ~queries)) 245 | ([parent-key kind queries] 246 | (let [kind-name (name kind)] 247 | `(let [q# (com.google.appengine.api.datastore.Query. ~kind-name) 248 | op-smap# {:= com.google.appengine.api.datastore.Query$FilterOperator/EQUAL 249 | :not= com.google.appengine.api.datastore.Query$FilterOperator/NOT_EQUAL 250 | :< com.google.appengine.api.datastore.Query$FilterOperator/LESS_THAN 251 | :<= com.google.appengine.api.datastore.Query$FilterOperator/LESS_THAN_OR_EQUAL 252 | :> com.google.appengine.api.datastore.Query$FilterOperator/GREATER_THAN 253 | :>= com.google.appengine.api.datastore.Query$FilterOperator/GREATER_THAN_OR_EQUAL 254 | :in com.google.appengine.api.datastore.Query$FilterOperator/IN} 255 | op-queries# (map (fn [query#] (replace op-smap# query#)) ~queries)] 256 | (when ~parent-key 257 | (.setAncestor q# ~parent-key)) 258 | (doseq [[operator# prop# value#] op-queries#] 259 | (. q# addFilter (name prop#) (eval operator#) value#)) 260 | q#)))) 261 | 262 | (defn get-by-keys 263 | "For a list of keys fetch the entities and return a map of key to entry" 264 | [#^java.util.Collection keys] 265 | (-> keys 266 | get-entities-by-keys 267 | (translate-map-vals (comp translate-from-datastore entity-to-map)))) 268 | 269 | (defn get-by-key 270 | "For a single key return the datastore entity" 271 | ([key] 272 | (-> key 273 | get-entity-by-key 274 | entity-to-map 275 | translate-from-datastore)) 276 | ([key not-found-val] 277 | (try 278 | (get-by-key key) 279 | (catch EntityNotFoundException e 280 | not-found-val)))) 281 | 282 | (defn resolve-entities 283 | "For a sequence of entities 'resolve' other entities that are referenced by 284 | keys. 285 | 286 | The function first selects all distinct keys from the given attributes. 287 | Then a batch get for all keys is done and afterwards all entities for these keys 288 | are assigned to the original entities." 289 | ([entities attr] 290 | (resolve-entities entities attr attr)) 291 | ([entities attr target-attr] 292 | (-> (distinct-entity-keys entities attr) 293 | get-by-keys 294 | (replace-map-vals entities attr target-attr)))) 295 | -------------------------------------------------------------------------------- /src/com/freiheit/gae/datastore/datastore_types.clj: -------------------------------------------------------------------------------- 1 | ;; Copyright (c) 2010 freiheit.com technologies gmbh 2 | ;; 3 | ;; This file is part of clj-gae-datastore. 4 | ;; clj-gae-datastore is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU Lesser General Public License as published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; clj-gae-datastore is distributed in the hope that it will be useful 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU Lesser General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU Lesser General Public License 15 | ;; along with clj-gae-datastore. If not, see . 16 | 17 | (ns com.freiheit.gae.datastore.datastore-types 18 | (:require 19 | [clj-time.coerce :as date] 20 | [clj-time.core :as date-core] 21 | [com.freiheit.gae.datastore.keys :as keys]) 22 | (:import 23 | [com.google.appengine.api.datastore Key Text Email])) 24 | 25 | ;;;; Some translation functions for the datastore api 26 | 27 | ;; ------------------------------------------------------------------------------ 28 | ;; public functions 29 | ;; ------------------------------------------------------------------------------ 30 | 31 | (defn to-text 32 | [#^String s] 33 | (com.google.appengine.api.datastore.Text. s)) 34 | 35 | (defn from-text 36 | [#^com.google.appengine.api.datastore.Text t] 37 | (.getValue t)) 38 | 39 | (defn to-ms 40 | [#^org.joda.time.DateTime date-time] 41 | (date/to-long date-time)) 42 | 43 | (defn from-ms 44 | [#^Long ms] 45 | (date/from-long ms)) 46 | 47 | (defn from-ms-with-tz 48 | [tz] 49 | (fn [#^Long ms] 50 | (-> (date/from-long ms) 51 | (date-core/to-time-zone tz)))) 52 | 53 | (def from-ms-with-default-tz 54 | (from-ms-with-tz (date-core/default-time-zone))) 55 | 56 | (defn to-e-mail 57 | [#^String e-mail-str] 58 | (com.google.appengine.api.datastore.Email. e-mail-str)) 59 | 60 | (defn from-e-mail 61 | [#^com.google.appengine.api.datastore.Email e] 62 | (.getEmail e)) 63 | 64 | (defn to-key 65 | [#^String key-string] 66 | (keys/make-key key-string)) 67 | 68 | (defn to-webkey 69 | [#^com.google.appengine.api.datastore.Key key] 70 | (keys/make-web-key key)) 71 | 72 | (def keyword-to-str 73 | (memoize name)) 74 | 75 | (def str-to-keyword 76 | (memoize keyword)) 77 | 78 | (defn to-sexpr-text 79 | [obj] 80 | (binding [*print-dup* true] 81 | (com.google.appengine.api.datastore.Text. (print-str obj)))) 82 | 83 | (defn from-sexpr-text 84 | [#^com.google.appengine.api.datastore.Text t] 85 | (if t 86 | (read-string (.getValue t)) 87 | t)) 88 | 89 | (defn to-vector 90 | [obj] 91 | (into [] obj)) 92 | 93 | (defn with-default 94 | "Executes the conversions with the given nil-val if a nil value is provided for the function." 95 | [f nil-val] 96 | (fn [val] 97 | (if-not (nil? val) 98 | (f val) 99 | (f nil-val)))) 100 | 101 | (defn with-default-value 102 | "Returns the given nil-val if a nil value is provided for the function." 103 | [f nil-val] 104 | (fn [val] 105 | (if-not (nil? val) 106 | (f val) 107 | nil-val))) 108 | -------------------------------------------------------------------------------- /src/com/freiheit/gae/datastore/keys.clj: -------------------------------------------------------------------------------- 1 | ;; Copyright (c) 2010 freiheit.com technologies gmbh 2 | ;; 3 | ;; This file is part of clj-gae-datastore. 4 | ;; clj-gae-datastore is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU Lesser General Public License as published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; clj-gae-datastore is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU Lesser General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU Lesser General Public License 15 | ;; along with clj-gae-datastore. If not, see . 16 | 17 | (ns com.freiheit.gae.datastore.keys 18 | (:use 19 | [clojure.test]) 20 | (:import 21 | [com.google.appengine.api.datastore KeyFactory Key])) 22 | 23 | ;; ------------------------------------------------------------------------------ 24 | ;; public functions 25 | ;; ------------------------------------------------------------------------------ 26 | 27 | (defn number-key? [key] 28 | (nil? (.getName key))) 29 | 30 | (defn named-key? [key] 31 | (not (number-key? key))) 32 | 33 | (defn make-key 34 | "Create a key for an entity. Can either be a websafe keystring, an appengine key (which 35 | will be returned unchanged) or a kind and a numeric id." 36 | ([key] 37 | (when key 38 | (cond 39 | (= Key (class key)) key 40 | true (KeyFactory/stringToKey key)))) 41 | ([kind key] 42 | (let [typed-key (if (= (class key) java.lang.Integer) 43 | (long key) 44 | key )] 45 | (KeyFactory/createKey kind typed-key))) 46 | ([parent kind name] 47 | (if (integer? name) 48 | (KeyFactory/createKey parent kind (long name)) 49 | (KeyFactory/createKey parent kind name)))) 50 | 51 | (defn append-key [parent child] 52 | (let [name (or (.getName child) 53 | (.getId child)) 54 | kind (.getKind child)] 55 | (if (nil? (.getParent child)) 56 | (make-key parent kind name) 57 | (make-key (append-key parent (.getParent child)) kind name)))) 58 | 59 | (defn make-named-key 60 | "Create a named key for an entity." 61 | ([#^String kind #^String keyname] 62 | (KeyFactory/createKey kind keyname))) 63 | 64 | (defn make-web-key 65 | "Create a websafe string representation of the key" 66 | [key] 67 | (when key 68 | (KeyFactory/keyToString key))) 69 | 70 | (defn valid-webkey? 71 | [webkey] 72 | (try (make-key webkey) 73 | true 74 | (catch java.lang.IllegalArgumentException e 75 | false))) 76 | -------------------------------------------------------------------------------- /src/com/freiheit/gae/datastore/transactions.clj: -------------------------------------------------------------------------------- 1 | ;; Copyright (c) 2010 freiheit.com technologies gmbh 2 | ;; 3 | ;; This file is part of clj-gae-datastore. 4 | ;; clj-gae-datastore is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU Lesser General Public License as published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; clj-gae-datastore is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU Lesser General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU Lesser General Public License 15 | ;; along with clj-gae-datastore. If not, see . 16 | 17 | (ns com.freiheit.gae.datastore.transactions 18 | (:require 19 | [clojure.tools.logging :as log]) 20 | (:import 21 | [com.google.appengine.api.datastore DatastoreServiceFactory TransactionOptions$Builder])) 22 | 23 | ;;;; Transaction support for the appengine. 24 | 25 | ;; ------------------------------------------------------------------------------ 26 | ;; public functions 27 | ;; ------------------------------------------------------------------------------ 28 | (defn begin-transaction 29 | "Begin a datastore transaction. Returns a new transaction." 30 | ([] 31 | (.beginTransaction (DatastoreServiceFactory/getDatastoreService))) 32 | ([options] 33 | (.beginTransaction (DatastoreServiceFactory/getDatastoreService) options))) 34 | 35 | (defn commit-transaction 36 | "Commit a transaction." 37 | [transaction] 38 | (.commit transaction)) 39 | 40 | (defn rollback-transaction 41 | "Rollback a transaction." 42 | [transaction] 43 | (.rollback transaction)) 44 | 45 | (defn current-transaction 46 | "Return the current transaction." 47 | [] 48 | (.getCurrentTransaction (DatastoreServiceFactory/getDatastoreService))) 49 | 50 | (defmacro with-transaction 51 | "Encapsulate code with a datastore transaction. The transaction is commited at the end." 52 | [& body] 53 | `(let [transaction# (begin-transaction)] 54 | (let [body# (do ~@body)] 55 | (commit-transaction transaction#) 56 | body#))) 57 | 58 | (defmacro with-xg-transaction 59 | "Encapsulate code with a cross group datastore transaction. The transaction is commited at the end." 60 | [& body] 61 | `(let [transaction# (begin-transaction (TransactionOptions$Builder/withXG true))] 62 | (let [body# (do ~@body)] 63 | (commit-transaction transaction#) 64 | body#))) 65 | 66 | (defn get-stack-trace 67 | "Get the string representation of the strack trace for the given Throwable." 68 | [#^java.lang.Throwable t] 69 | (with-open [#^java.io.StringWriter string-writer (java.io.StringWriter.) 70 | #^java.io.PrintWriter print-writer (java.io.PrintWriter. string-writer true)] 71 | (do 72 | (.printStackTrace t print-writer) 73 | (str string-writer)))) 74 | 75 | (defmacro with-transaction-rethrow 76 | "Encapsulate code with a datastore transaction. The transaction is commited at the end. If an exception 77 | has occured then the transaction is rolled back. The exception is rethrown." 78 | [& body] 79 | `(let [transaction# (begin-transaction)] 80 | (try 81 | (let [body# (do ~@body)] 82 | (commit-transaction transaction#) 83 | body#) 84 | (catch Exception e# 85 | (log/log :error (str "Exception during transaction.\n\n" (get-stack-trace e#))) 86 | (when (.isActive transaction#) 87 | (rollback-transaction transaction#)) 88 | (throw e#))))) 89 | 90 | (defmacro with-xg-transaction-rethrow 91 | "Encapsulate code with a datastore transaction. The transaction is commited at the end. If an exception 92 | has occured then the transaction is rolled back. The exception is rethrown." 93 | [& body] 94 | `(let [transaction# (begin-transaction (TransactionOptions$Builder/withXG true))] 95 | (try 96 | (let [body# (do ~@body)] 97 | (commit-transaction transaction#) 98 | body#) 99 | (catch Exception e# 100 | (log/log :error (str "Exception during transaction.\n\n" (get-stack-trace e#))) 101 | (when (.isActive transaction#) 102 | (rollback-transaction transaction#)) 103 | (throw e#))))) 104 | -------------------------------------------------------------------------------- /src/com/freiheit/gae/local_dev.clj: -------------------------------------------------------------------------------- 1 | (ns com.freiheit.gae.local-dev 2 | "Tools for local development. 3 | Enables the use of the App Engine APIs on the REPL and in a local Jetty instance. 4 | Usage: (require 'local-dev) (local-dev/init-app-engine) (local-dev/start-server (var example))" 5 | (:use ring.adapter.jetty 6 | [ring.middleware file file-info] 7 | [ring.util.response :only [redirect]] 8 | compojure.core 9 | [hiccup.core :only[html]] 10 | [ring.middleware.cookies] 11 | [ring.middleware.stacktrace]) 12 | (:require [compojure.route :as route]) 13 | (:import [java.io File] 14 | [java.util HashMap] 15 | [com.google.apphosting.api ApiProxy ApiProxy$Environment] 16 | [com.google.appengine.tools.development 17 | ApiProxyLocalFactory 18 | LocalServerEnvironment])) 19 | 20 | (defonce server (atom nil)) 21 | (def port 8080) 22 | (def login-info (atom {:logged-in? false 23 | :admin? false 24 | :email "" 25 | :auth-domain ""})) 26 | 27 | (defn login 28 | ([email] (login email false)) 29 | ([email admin?] (swap! login-info merge {:email email 30 | :logged-in? true 31 | :admin? admin?}))) 32 | 33 | (defn logout [] 34 | (swap! login-info merge {:email "" 35 | :logged-in? false 36 | :admin? false})) 37 | 38 | (defn- set-app-engine-environment [] 39 | "Sets up the App Engine environment for the current thread." 40 | (let [att (HashMap. {"com.google.appengine.server_url_key" 41 | (str "http://localhost:" port)}) 42 | env-proxy (proxy [ApiProxy$Environment] [] 43 | (isLoggedIn [] (:logged-in? @login-info)) 44 | (getEmail [] (:email @login-info)) 45 | (getAuthDomain [] (:auth-domain @login-info)) 46 | (isAdmin [] (:admin? @login-info)) 47 | (getRequestNamespace [] "") 48 | (getDefaultNamespace [] "") 49 | (getAttributes [] att) 50 | (getAppId [] "_local_"))] 51 | (ApiProxy/setEnvironmentForCurrentThread env-proxy))) 52 | 53 | (defn- set-app-engine-delegate [dir] 54 | "Initializes the App Engine services. Needs to be run (at least) per JVM." 55 | (let [local-env (proxy [LocalServerEnvironment] [] 56 | (enforceApiDeadlines [] true) 57 | (simulateProductionLatencies [] false) 58 | (getAppDir [] (File. dir)) 59 | (getAddress [] "localhost") 60 | (getPort [] port) 61 | (waitForServerToStart [] nil)) 62 | api-proxy (.create (ApiProxyLocalFactory.) 63 | local-env)] 64 | (ApiProxy/setDelegate api-proxy))) 65 | 66 | (defn init-app-engine 67 | "Initializes the App Engine services and sets up the environment. To be called from the REPL." 68 | ([] (init-app-engine "/tmp")) 69 | ([dir] 70 | (set-app-engine-delegate dir) 71 | (set-app-engine-environment))) 72 | 73 | (defn wrap-local-app-engine [app] 74 | "Wraps a ring app to enable the use of App Engine Services." 75 | (fn [req] 76 | (set-app-engine-environment) 77 | (app req))) 78 | 79 | (defn login-form [continue] 80 | (html [:html 81 | [:body 82 | [:form {:method :post :style "text-align:center; font:13px sans-serif"} ; 83 | [:div {:style "width: 20em; margin: 1em auto; text-align: left; padding: 0 2em 1.25em 2em; background-color: #d6e9f8; border: 2px solid #67a7e3"} 84 | [:h3 "Not logged in"] 85 | [:p {:style "padding: 0; margin: 0"} 86 | [:label {:for :email :style "width: 3em"} "Email:"] 87 | [:input#email {:type :text :name :email :value "test@example.com"}]] 88 | [:p {:style "margin: .5em 0 0 3em; font-size:12px"} 89 | [:input#isAdmin {:type :checkbox :name :isAdmin}] 90 | [:label {:for :isAdmin} "Sign in as Administrator"]] 91 | [:input {:type :hidden :name :continue :value continue}] 92 | [:p {:style "margin-left: 3em;"} 93 | [:input {:type :submit :name :action :value "Log In"}] 94 | [:input {:type :submit :name :action :value "Log Out"}]]]]]])) 95 | 96 | (defroutes login-routes 97 | (GET "/_ah/login" [continue] (login-form continue)) 98 | (POST "/_ah/login" [action email isAdmin continue] (do (if (= action "Log In") 99 | (login email (boolean isAdmin)) 100 | (logout)) 101 | (redirect continue))) 102 | (GET "/_ah/logout" [continue] (do (logout) 103 | (redirect continue)))) 104 | 105 | (defn start-server [app-routes] 106 | "Initializes the App Engine services and (re-)starts a Jetty server 107 | running the supplied ring app, wrapping it to enable App Engine API use 108 | and serving of static files." 109 | (set-app-engine-delegate "/tmp") 110 | (swap! server (fn [instance] 111 | (when instance 112 | (.stop instance)) 113 | (let [app (-> (routes login-routes app-routes) 114 | (wrap-local-app-engine) 115 | (wrap-file "./web") 116 | (wrap-file-info))] 117 | (System/setProperty "development" "true") 118 | (run-jetty app {:port port 119 | :join? false}))))) 120 | 121 | (defn stop-server [] 122 | "Stops the local Jetty server." 123 | (swap! server #(when % (.stop %)))) 124 | -------------------------------------------------------------------------------- /src/example/com/freiheit/gae/datastore/example.clj: -------------------------------------------------------------------------------- 1 | (ns com.freiheit.gae.datastore.example 2 | (:require 3 | [com.freiheit.gae.datastore.datastore-access-dsl :as datastore] 4 | [com.freiheit.gae.datastore.datastore-query-dsl :as query] 5 | [com.freiheit.gae.datastore.datastore-types :as types]) 6 | (:import 7 | [com.google.apphosting.api ApiProxy ApiProxy$Environment] 8 | [java.io File] 9 | [java.util HashMap] 10 | [com.google.appengine.tools.development ApiProxyLocalFactory ApiProxyLocalImpl LocalServiceContext LocalServerEnvironment] 11 | [com.google.appengine.api.labs.taskqueue.dev LocalTaskQueue])) 12 | 13 | (datastore/defentity book 14 | [:key] 15 | [:title :unindexed true] ;TODO: :unindexed is not evaluated at the moment, but can be specified 16 | [:author] 17 | [:publisher] 18 | [:isbn] 19 | [:pages] 20 | [:outofprint 21 | :pre-save #(= % "yes") 22 | :post-load #(if % 23 | "yes" 24 | "no")]) 25 | 26 | (datastore/defentity person 27 | [:key] 28 | [:name] 29 | [:books]) 30 | 31 | (def *books* 32 | (list (make-book :title "On Lisp" 33 | :author "Paul Graham" 34 | :publisher "Prentice Hall" 35 | :isbn "978-0130305527" 36 | :pages 413 37 | :outofprint "yes") 38 | (make-book :title "Paradigms of Artificial Intelligence Programming: Case Studies in Common Lisp" 39 | :author "Peter Norvig" 40 | :publisher "Morgan Kaufmann" 41 | :isbn "978-1558601918" 42 | :pages 946 43 | :outofprint "no") 44 | (make-book :title "Programming Clojure" 45 | :author "Stuart Halloway" 46 | :publisher "Pragmatic Programmers" 47 | :isbn "978-1934356333" 48 | :pages 304 49 | :outofprint "no"))) 50 | 51 | (defn save-books-to-datastore 52 | "Stores all books from the var *books* to the datastore." 53 | [] 54 | (datastore/store-entities! *books*)) 55 | 56 | (defn load-all-books-from-datastore 57 | "Loads all books from the datastore." 58 | [] 59 | (query/select (query/where book []))) 60 | 61 | (defn load-norvig-books-from-datastore 62 | "Load all books from the datastore, where the author is 'Peter Norvig'" 63 | [] 64 | (query/select (query/where book ([= :author "Peter Norvig"])))) 65 | 66 | (defn save-person-to-datastore 67 | "Stores some users into the datastore" 68 | [] 69 | (datastore/store-entities! [(make-person :books (map :key (load-norvig-books-from-datastore)))])) 70 | 71 | (defn load-all-persons-from-datastore 72 | "Load all persons from the datastore" 73 | [] 74 | (query/select (query/where person []))) 75 | 76 | (defn load-all-persons-with-books 77 | "Load all persons and resolve the book keys" 78 | [] 79 | (query/resolve-entities (load-all-persons-from-datastore) :books)) 80 | 81 | (defn change-book-in-datastore 82 | "Renames the author of the first book in the datastore to 'P. Graham'" 83 | [] 84 | (let [book (first (load-all-books-from-datastore))] 85 | (datastore/update-entities! [(datastore/assoc-and-track-changes book :author "P. Graham")]))) 86 | 87 | (defn delete-books-from-datastore 88 | "Cleans the datastore by selecting the keys of all books and then using these keys 89 | to delete the data." 90 | [] 91 | (let [keys (query/select-only-keys (query/where book []))] 92 | (datastore/delete-all! keys))) 93 | 94 | (defn init-app-engine 95 | "Initialize the app engine services. Call it once from the REPL" 96 | ([] 97 | (init-app-engine "/tmp")) 98 | ([dir] 99 | (let [default-port 9090 100 | env-proxy (proxy [ApiProxy$Environment] [] 101 | (isLoggedIn [] false) 102 | (getRequestNamespace [] "") 103 | (getDefaultNamespace [] "") 104 | (getAttributes [] (let [attributes (HashMap.) 105 | local-server-url (str "http://localhost:" default-port)] 106 | (.put attributes "com.google.appengine.server_url_key" local-server-url) 107 | attributes)) 108 | (getAppId [] "local")) 109 | local-env (proxy [LocalServerEnvironment] [] 110 | (getAppDir [] (File. dir)) 111 | (getAddress [] "localhost") 112 | (getPort [] default-port) 113 | (waitForServerToStart [] nil)) 114 | api-proxy (.create (ApiProxyLocalFactory.) local-env)] 115 | (do 116 | (com.google.apphosting.api.ApiProxy/setEnvironmentForCurrentThread env-proxy) 117 | (com.google.apphosting.api.ApiProxy/setDelegate api-proxy))))) 118 | --------------------------------------------------------------------------------