Permalink
Browse files

Documentation updates.

  • Loading branch information...
gcv committed Nov 7, 2011
1 parent acc80e5 commit a5ae10d98d5b5b51f70e9aedb743e4136cadece6
Showing with 17 additions and 17 deletions.
  1. +2 −6 HISTORY.md
  2. +15 −11 README.md
View
@@ -1,11 +1,7 @@
-## 0.4.6 (???)
+## 0.4.6 (2011-11-07)
+* Basic support for App Engine SDK 1.5.5.
* Added support for `:before-save` and `:after-load` hooks to `defentity`.
- (TODO: Write documentation for this feature.) Both take a function which takes
- and returns an entity record, and applies this function as a transformation to
- the entity. `:before-save` does this before it writes something to the
- datastore, and `:after-load` does this right after a datastore read, and
- returns the transformed entity from `retrieve` and `query` results.
* Made an internal change which improves support for interactive REPL use from
various programming tools. Clojure modes in Eclipse, IntelliJ IDEA, and
NetBeans should now work. VimClojure, SLIME (swank-clojure), and plain REPL
View
@@ -26,7 +26,7 @@ Please read the project's HISTORY file to learn what changed in recent releases.
* Clojure 1.2.1 or Clojure 1.3.0
* Leiningen 1.6.1
-* Google App Engine SDK 1.5.4
+* Google App Engine SDK 1.5.5
@@ -512,16 +512,19 @@ and transactions.
(ANY "*" [] {:status 404 :body "not found" :headers {"Content-Type" "text/plain"}}))
```
-- `defentity` (optional keyword: `:kind`): defines an entity record type
- suitable for storing in the App Engine datastore. These entities work just
- like Clojure records. Internally, they implement an additional protocol,
- EntityProtocol, which provides the `save!` method. When defining an entity,
- you may specify `^:key` metadata on any one field of the record, and the
- datastore will use this as the primary key. Omitting the key will make the
- datastore assign an automatic primary key to the entity. Specifying the
- optional `:kind` keyword (a string value) causes App Engine to save the entity
- under the given "kind" name — like a datastore table. This allows kinds to
- remain disjoint from entity record types.
+- `defentity` (optional keywords: `:kind`, `:before-save`, `:after-load`):
+ defines an entity record type suitable for storing in the App Engine
+ datastore. These entities work just like Clojure records. Internally, they
+ implement an additional protocol, EntityProtocol, which provides the `save!`
+ method. When defining an entity, you may specify `^:key` metadata on any one
+ field of the record, and the datastore will use this as the primary key.
+ Omitting the key will make the datastore assign an automatic primary key to
+ the entity. Specifying the optional `:kind` keyword (a string value) causes
+ App Engine to save the entity under the given "kind" name — like a datastore
+ table. This allows kinds to remain disjoint from entity record types. The
+ `:before-save` and `:after-load` keywords allow specifying a hook for
+ transforming the entity on its way into the datastore before it is saved, or
+ on its way out of the datastore after it is read.
- `new*`: instantiates a datastore entity record. You may also use standard
Clojure conventions to instantiate entity records, but creating entities
destined for entity groups requires using `new*`. To put the new entity into a
@@ -941,6 +944,7 @@ console, you'll see the polling requests.
The following Google services are not yet tested in the REPL environment:
+- Asynchronous Memcache API requests (from App Engine SDK 1.6.0)
- Pull queues (from App Engine SDK 1.5.0)
- Deferred API (from App Engine SDK 1.4.3)
- Remote API (from App Engine SDK 1.4.3)

0 comments on commit a5ae10d

Please sign in to comment.