Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 586 lines (454 sloc) 22.343 kb
cd6c915 Simple prefetching works.
zef authored
1 persistence.js
2 ==============
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
3 `persistence.js` is a asynchronous Javascript object-relational
4 mapper library. It can be used both in the web browser and on
5 the server using [node.js](http://nodejs.org). It currently
6 supports 4 types of data stores:
7
8 * [HTML5 WebSQL database](http://dev.w3.org/html5/webdatabase/), a
9 somewhat controversial part of HTML5 that is supported in Webkit
10 browsers, specifically on mobile devices, including iPhone, Android
11 and Palm's WebOS.
12 * [Google Gears](http://gears.google.com), a browser plug-in that adds
13 a number of feature to the browser, including a in-browser database.
14 * [MySQL](http://www.mysql.com), using the
8e903cc @zefhemel Changed used mysql connector
zefhemel authored
15 [node-mysql](http://github.com/felixge/node-mysql), node.js module
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
16 on the server.
17 * In-memory, as a fallback. Keeps the database in memory and is cleaned
18 upon a page refresh (or server restart).
19
20 There is also an experimental support for [Qt 4.7 Declarative UI
21 framework
22 (QML)](http://doc.trolltech.org/4.7-snapshot/declarativeui.html) which
23 is an extension to JavaScript.
1b2c013 @zefhemel Documentation tweaks to accomodate for server environments.
zefhemel authored
24
25 For browser use, `persistence.js` has no dependencies on any other
26 frameworks, other than the Google Gears [initialization
27 script](http://code.google.com/apis/gears/gears_init.js), in case you
28 want to enable Gears support.
cd6c915 Simple prefetching works.
zef authored
29
3d5d3f0 @zefhemel Fixes to node blogging example, and description of plug-ins added to
zefhemel authored
30 Plug-ins
31 --------
32
33 There are a few `persistence.js` plug-ins available that add functionality:
34
35 * `persistence.search.js`, adds simple full-text search capabilities,
36 see `docs/search.md` for more information.
37 * `persistence.migrations.js`, supports data migrations (changes to
38 the database schema), see `docs/migrations.md` for more information.
39 * `persistence.sync.js`, supports database synchronization with a
40 remote server, see `docs/sync.md` for more information.
41
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
42 A Brief Intro to Async Programming
43 ----------------------------------
bf2edb5 More info on asynchronous programming
Zef Hemel authored
44
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
45 In browsers, Javascript and the web page's rendering engine share
46 a single thread. The result of this is that only one thing can happen
47 at a time. If a database query would be performed _synchronously_,
48 like in many other programming environments like Java and PHP the
49 browser would freeze from the moment the query was issued until the
50 results came back. Therefore, many APIs in Javascript are defined as
51 _asynchronous_ APIs, which mean that they do not block when an
52 "expensive" computation is performed, but instead provide the call
53 with a function that will be invoked once the result is known. In the
54 meantime, the browser can perform other duties.
bf2edb5 More info on asynchronous programming
Zef Hemel authored
55
56 For instance, a synchronous database call call would look as follows:
57
58 var results = db.query("SELECT * FROM Table");
59 for(...) { ... }
60
61 The execution of the first statement could take half a second, during
62 which the browser doesn't do anything else. By contrast, the
63 asynchronous version looks as follows:
64
65 db.query("SELECT * FROM Table", function(results) {
66 for(...) { ... }
67 });
68
69 Note that there will be a delay between the `db.query` call and the
70 result being available and that while the database is processing the
71 query, the execution of the Javascript continues. To make this clear,
72 consider the following program:
73
74 db.query("SELECT * FROM Table", function(results) {
75 console.log("hello");
76 });
77 console.log("world");
78
79 Although one could assume this would print "hello", followed by
80 "world", the result will likely be that "world" is printed before
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
81 "hello", because "hello" is only printed when the results from the
bf2edb5 More info on asynchronous programming
Zef Hemel authored
82 query are available. This is a tricky thing about asynchronous
83 programming that a Javascript developer will have to get used to.
84
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
85 Using persistence.js in the browser
86 ===================================
87
14f8aac Working on the readme
Zef Hemel authored
88 Browser support
89 ---------------
90
91 * Modern webkit browsers (Google Chrome and Safari)
92 * Firefox (through Google Gears)
792501e @zefhemel Working on selectJSON, refactoring some code.
zefhemel authored
93 * Android browser (tested on 1.6 and 2.x)
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
94 * iPhone browser (iPhone OS 3+)
06e6304 Added WebOS to supported platforms.
Zef Hemel authored
95 * Palm WebOS (tested on 1.4.0)
cd6c915 Simple prefetching works.
zef authored
96
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
97 (The following is being worked on:)
14f8aac Working on the readme
Zef Hemel authored
98 Internet Explorer is likely not supported (untested) because it
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
99 lacks `__defineGetter__` and `__defineSetter__` support, which
100 `persistence.js` uses heavily. This may change in IE 8.
14f8aac Working on the readme
Zef Hemel authored
101
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
102 Setting up
103 ----------
104
105 To use `persistence.js` you need to clone the git repository:
106
107 git clone git://github.com/zefhemel/persistencejs.git
108
559e75c @zefhemel Doc update
zefhemel authored
109 To use it you need to copy `lib/persistence.js` to your web directory,
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
110 as well as any data stores you want to use. Note that the `mysql` and
111 `websql` stores both depend on the `sql` store. A typical setup
559e75c @zefhemel Doc update
zefhemel authored
112 requires you to copy at least `lib/persistence.js`,
113 `lib/persistence.store.sql.js` and `lib/persistence.store.websql.js` to your
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
114 web directory. You can then load them as follows:
115
116 <script src="persistence.js" type="application/javascript"></script>
117 <script src="persistence.store.sql.js" type="application/javascript"></script>
118 <script src="persistence.store.websql.js" type="application/javascript"></script>
119
14f8aac Working on the readme
Zef Hemel authored
120
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
121 Setup your database
122 -------------------
cd6c915 Simple prefetching works.
zef authored
123
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
124 You need to explicitly configure the data store you want to use,
125 configuration of the data store is store-specific. The WebSQL store
126 (which includes Google Gears support) is configured as follows:
127
128 persistence.store.websql.config(persistence, 'yourdbname', 'A database description', 5 * 1024 * 1024);
129
130 The first argument is always supposed to be `persistence`. The second
131 in your database name (it will create it if it does not already exist,
132 the third is a description for you database, the last argument is the
133 maximum size of your database in bytes (5MB in this example).
134
135 If you're using the in-memory store, you can configure it as follows:
136
137 persistence.store.memory.config(persistence);
14f8aac Working on the readme
Zef Hemel authored
138
139 Schema definition
140 -----------------
141
142 A data model is declared using `persistence.define`. The following two
143 definitions define a `Task` and `Category` entity with a few simple
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
144 properties. The property types are based on [SQLite
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
145 types](http://www.sqlite.org/datatype3.html), specifically supported
146 types are (but any SQLite type is supported):
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
147
148 * `TEXT`: for textual data
149 * `INT`: for numeric values
150 * `BOOL`: for boolean values (`true` or `false`)
c65213f Added Fabio's Date type to documentation.
Zef Hemel authored
151 * `DATE`: for date/time value (with precision of 1 second)
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
152 * `JSON`: a special type that can be used to store arbitrary
153 [JSON](http://www.json.org) data. Note that this data can not be used
1e94adf Some more JSON property examples + minified version.
Zef Hemel authored
154 to filter or sort in any sensible way. If internal changes are made to a `JSON`
155 property, `persistence.js` may not register them. Therefore, a manual
156 call to `anObj.markDirty('jsonPropertyName')` is required before calling
157 `persistence.flush`.
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
158
159 Example use:
cd6c915 Simple prefetching works.
zef authored
160
73724ff Added .add and .remove methods to QueryCollections.
zef authored
161 var Task = persistence.define('Task', {
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
162 name: "TEXT",
163 description: "TEXT",
164 done: "BOOL"
cd6c915 Simple prefetching works.
zef authored
165 });
166
73724ff Added .add and .remove methods to QueryCollections.
zef authored
167 var Category = persistence.define('Category', {
1e94adf Some more JSON property examples + minified version.
Zef Hemel authored
168 name: "TEXT",
169 metaData: "JSON"
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
170 });
171
172 var Tag = persistence.define('Task', {
173 name: "TEXT"
cd6c915 Simple prefetching works.
zef authored
174 });
175
14f8aac Working on the readme
Zef Hemel authored
176 The returned values are constructor functions and can be used to
177 create new instances of these entities later:
cd6c915 Simple prefetching works.
zef authored
178
179
14f8aac Working on the readme
Zef Hemel authored
180 Relationships between entities are defined using the constructor
181 function's `hasMany` call:
cd6c915 Simple prefetching works.
zef authored
182
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
183 // This defines a one-to-many relationship:
73724ff Added .add and .remove methods to QueryCollections.
zef authored
184 Category.hasMany('tasks', Task, 'category');
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
185 // These two definitions define a many-to-many relationship
186 Task.hasMany('tags', Tag, 'tasks');
187 Tag.hasMany('tasks', Task, 'tags');
cd6c915 Simple prefetching works.
zef authored
188
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
189 The first statement defines a `tasks` relationship on category objects
190 containing a `QueryCollection` (see the section on query collections
191 later) of `Task`s, it also defines an inverse relationship on `Task`
192 objects with the name `category`. The last two statements define a
193 many-to-many relationships between `Task` and `Tag`. `Task` gets a
194 `tags` property (a `QueryCollection`) containing all its tags and vice
195 versa, `Tag` gets a `tasks` property containing all of its tasks.
cd6c915 Simple prefetching works.
zef authored
196
14f8aac Working on the readme
Zef Hemel authored
197 The defined entity definitions are synchronized (activated) with the
198 database using a `persistence.schemaSync` call, which takes a callback
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
199 function (with a newly created transaction as an argument), that is called
14f8aac Working on the readme
Zef Hemel authored
200 when the schema synchronization has completed, the callback is
201 optional.
cd6c915 Simple prefetching works.
zef authored
202
203 persistence.schemaSync();
73724ff Added .add and .remove methods to QueryCollections.
zef authored
204 // or
14f8aac Working on the readme
Zef Hemel authored
205 persistence.schemaSync(function(tx) {
206 // tx is the transaction object of the transaction that was
207 // automatically started
208 });
cd6c915 Simple prefetching works.
zef authored
209
eae6f59 @fgrehm Finishing up documentation
fgrehm authored
210 There is also a migrations plugin you can check out, documentation can be found
58183c9 @fgrehm Fixing link to migrations documentation
fgrehm authored
211 in [persistence.migrations.docs.md](migrations/persistence.migrations.docs.md) file.
eae6f59 @fgrehm Finishing up documentation
fgrehm authored
212
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
213 Creating and manipulating objects
214 ---------------------------------
215
216 New objects can be instantiated with the constructor functions.
217 Optionally, an object with initial property values can be passed as
218 well, or the properties may be set later:
219
220 var task = new Task();
221 var category = new Category({name: "My category"});
1e94adf Some more JSON property examples + minified version.
Zef Hemel authored
222 category.metaData = {rating: 5};
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
223 var tag = new Tag();
224 tag.name = "work";
225
226 Many-to-one relationships are accessed using their specified name, e.g.:
227 task.category = category;
228
229 One-to-many and many-to-many relationships are access and manipulated
230 through the `QueryCollection` API that will be discussed later:
231
232 task.tags.add(tag);
233 tasks.tags.remove(tag)l
234 tasks.tags.list(tx, function(allTags) { console.log(allTags); });
235
4941cd3 Added support for object removal (via `persistence.remove`).
Zef Hemel authored
236 Persisting/removing objects
e2d2c10 @zefhemel IMPORTANT: Minor breaking changes!
zefhemel authored
237 ---------------------------
cd6c915 Simple prefetching works.
zef authored
238
14f8aac Working on the readme
Zef Hemel authored
239 Similar to [hibernate](http://www.hibernate.org), `persistence.js`
240 uses a tracking mechanism to determine which objects' changes have to
241 be persisted to the datase. All objects retrieved from the database
242 are automatically tracked for changes. New entities can be tracked to
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
243 be persisted using the `persistence.add` function:
cd6c915 Simple prefetching works.
zef authored
244
c37c40d Formatted readme slightly
Zef Hemel authored
245 var c = new Category({name: "Main category"});
246 persistence.add(c);
247 for ( var i = 0; i < 5; i++) {
248 var t = new Task();
249 t.name = 'Task ' + i;
250 t.done = i % 2 == 0;
251 t.category = c;
252 persistence.add(t);
253 }
cd6c915 Simple prefetching works.
zef authored
254
4941cd3 Added support for object removal (via `persistence.remove`).
Zef Hemel authored
255 Objects can also be removed from the database:
256
257 persistence.remove(c);
258
14f8aac Working on the readme
Zef Hemel authored
259 All changes made to tracked objects can be flushed to the database by
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
260 using `persistence.flush`, which takes a transaction object and
261 callback function as arguments. A new transaction can be started using
e38fbe0 Got rid of redundancy in readme.
Zef Hemel authored
262 `persistence.transaction`:
cd6c915 Simple prefetching works.
zef authored
263
264 persistence.transaction(function(tx) {
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
265 persistence.flush(tx, function() {
266 alert('Done flushing!');
267 });
268 });
14f8aac Working on the readme
Zef Hemel authored
269
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
270 For convenience, it is also possible to not specify a transaction or
271 callback, in that case a new transaction will be started
272 automatically. For instance:
14f8aac Working on the readme
Zef Hemel authored
273
274 persistence.flush();
275 // or, with callback
e2d2c10 @zefhemel IMPORTANT: Minor breaking changes!
zefhemel authored
276 persistence.flush(function() {
14f8aac Working on the readme
Zef Hemel authored
277 alert('Done flushing');
278 });
279
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
280 Note that when no callback is defined, the flushing still happens
281 asynchronously.
14f8aac Working on the readme
Zef Hemel authored
282
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
283 __Important__: Changes and new objects will not be persisted until you
284 explicitly call `persistence.flush()`. The exception to this rule is
e38fbe0 Got rid of redundancy in readme.
Zef Hemel authored
285 using the `list(...)` method on a database `QueryCollection`, which also
286 flushes first, although this behavior may change in the future.
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
287
d61084e persistence.sync.js now keeps track of changes to all entities in
Zef Hemel authored
288 Dumping and restoring data
792501e @zefhemel Working on selectJSON, refactoring some code.
zefhemel authored
289 --------------------------
290
291 The library supports two kinds of dumping and restoring data.
ef3606a A simple database dump function. Restore will come soon.
Zef Hemel authored
292
293 `persistence.dump` can be used to create an object containing a full
294 dump of a database. Naturally, it is adviced to only do this with
295 smaller databases. Example:
296
297 persistence.dump(tx, [Task, Category], function(dump) {
298 console.log(dump);
299 });
300
e2d2c10 @zefhemel IMPORTANT: Minor breaking changes!
zefhemel authored
301 The `tx` is left out, a new transaction will be started for the
302 operation. If the second argument is left out, `dump` defaults
303 to dumping _all_ defined entities.
ef3606a A simple database dump function. Restore will come soon.
Zef Hemel authored
304
305 The dump format is:
306
307 {"entity-name": [list of instances],
308 ...}
309
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
310 `persistence.load` is used to restore the dump produced by
311 `persistence.dump`. Usage:
312
313 persistence.load(tx, dumpObj, function() {
314 alert('Dump restored!');
315 });
316
e2d2c10 @zefhemel IMPORTANT: Minor breaking changes!
zefhemel authored
317 The `tx` argument can be left out to automatically start a new
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
318 transaction. Note that `persistence.load` does not empty the database
319 first, it simply attempts to add all objects to the database. If
320 objects with, e.g. the same ID already exist, this will fail.
ef3606a A simple database dump function. Restore will come soon.
Zef Hemel authored
321
d61084e persistence.sync.js now keeps track of changes to all entities in
Zef Hemel authored
322 Similarly, `persistence.loadFromJson` and `persistence.dumpToJson`
323 respectively load and dump all the database's data as JSON strings.
324
e2d2c10 @zefhemel IMPORTANT: Minor breaking changes!
zefhemel authored
325 Entity constructor functions
326 ----------------------------
327
328 The constructor function returned by a `persistence.define` call
329 cannot only be used to instantiate new objects, it also has some
330 useful methods of its own:
331
332 * `EntityName.all([session])` returns a query collection containing
333 all
334 persisted instances of that object. The `session` argument is
335 optional and only required when `persistence.js` is used in
336 multi-session mode.
337 * `EntityName.load([session], [tx], id, callback)` loads an particular
338 object from the database by id or returns `null` if it has not been
339 found.
340 * `EntityName.findBy([session], [tx], property, value, callback)` searches
341 for a particular object based on a property value (this is assumed to
342 be unique), the callback function is called with the found object or
343 `null` if it has not been found.
344
345 And of course the methods to define relationships to other entities:
346
347 * `EntityName.hasMany(property, Entity, inverseProperty)` defines a
348 1:N or N:M relationship (depending on the inverse property)
349 * `EntityName.hasOne(property, Entity)` defines a 1:1 or N:1
350 relationship
351
d714e0d @zefhemel Added `selectJSON` method to entity objects, see README.md for
zefhemel authored
352
353 Entity objects
354 --------------
355
356 Entity instances also have a few predefined properties and methods you
357 should be aware of:
358
359 * `obj.id`, contains the identifier of your entity, this is a
360 automatically generated (approximation of a) UUID. You should
361 never write to this property.
362 * `obj.fetch(prop, callback)`, if an object has a `hasOne`
363 relationship to another which has not yet been fetched from the
364 database (e.g. when `prefetch` wasn't used), you can fetch in manually
365 using `fetch`. When the property object is retrieved the callback function
366 is invoked with the result, the result is also cached in the entity
367 object itself.
368 * `obj.selectJSON([tx], propertySpec, callback)`, sometime you need to extract
4c18f83 @zefhemel Another README fix...
zefhemel authored
369 a subset of data from an entity. You for instance need to post a
370 JSON representation of your entity, but do not want to include all
371 properties. `selectJSON` allows you to do that. The `propertySpec`
372 arguments expects an array with property names. Some examples:
d714e0d @zefhemel Added `selectJSON` method to entity objects, see README.md for
zefhemel authored
373 * `['id', 'name']`, will return an object with the id and name property of this entity
374 * `['*']`, will return an object with all the properties of this entity, not recursive
375 * `['project.name']`, will return an object with a project property which has a name
11dedaf @zefhemel README fixes
zefhemel authored
376 property containing the project name (hasOne relationship)
d714e0d @zefhemel Added `selectJSON` method to entity objects, see README.md for
zefhemel authored
377 * `['project.[id, name]']`, will return an object with a project property which has an
11dedaf @zefhemel README fixes
zefhemel authored
378 id and name property containing the project name (hasOne relationship)
d714e0d @zefhemel Added `selectJSON` method to entity objects, see README.md for
zefhemel authored
379 * `['tags.name']`, will return an object with an array `tags` property containing
11dedaf @zefhemel README fixes
zefhemel authored
380 objects each with a single property: name
d714e0d @zefhemel Added `selectJSON` method to entity objects, see README.md for
zefhemel authored
381
382
14f8aac Working on the readme
Zef Hemel authored
383 Query collections
384 -----------------
385
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
386 A core concept of `persistence.js` is the `QueryCollection`. A
14f8aac Working on the readme
Zef Hemel authored
387 `QueryCollection` represents a (sometimes) virtual collection that can
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
388 be filtered, ordered or paginated. `QueryCollection`s are somewhate
389 inspired by [Google AppEngine's Query
390 class](http://code.google.com/appengine/docs/python/datastore/queryclass.html).
14f8aac Working on the readme
Zef Hemel authored
391 A `QueryCollection` has the following methods:
392
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
393 * `filter(property, operator, value)`
033f67a Added .limit(n) and .skip(n) support.
Zef Hemel authored
394 Returns a new `QueryCollection` that adds a filter, filtering a
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
395 certain property based on an operator and value. Supported operators
80824fe @zefhemel Introduced bug fixes, and new 'not in' operator.
zefhemel authored
396 are '=', '!=', '<', '<=', '>', '>=', 'in' and 'not in'. Example:
397 `.filter('done', '=', true)`
3843c74 @zefhemel Added or filters, usage (example in test/test.persistence.js):
zefhemel authored
398 * `or(filter)`
399 Returns a new `QueryCollection` that contains items either matching
400 the filters specified before calling `or`, or the filter represented
401 in the argument. The `filter` argument is of a `Filter` type, there
402 are three types of filters:
403 - `persistence.PropertyFilter`, which filters on properties (internally called when `filter(...)` is used.
404 Example: `new persistence.PropertyFilter('done', '=', true)`
405 - `persistence.AndFilter`, which is passed two filter objects as arguments, both of which should be true.
406 Example: `new persistence.AndFilter(new persistence.PropertyFilter('done', '=', true), new persistence.PropertyFilter('archived', '=', true))`
407 - `persistence.OrFilter`, which is passed two filter objects as arguments, one of which should be true.
408 Example: `new persistence.OrFilter(new persistence.PropertyFilter('done', '=', true), new persistence.PropertyFilter('archived', '=', true))`
409 * `and(filter)`
410 same as `or(filter)` except that both conditions should hold for items to be in the collection.
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
411 * `order(property, ascending)`
033f67a Added .limit(n) and .skip(n) support.
Zef Hemel authored
412 Returns a new `QueryCollection` that will order its results by the
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
413 property specified in either an ascending (ascending === true) or
414 descending (ascending === false) order.
033f67a Added .limit(n) and .skip(n) support.
Zef Hemel authored
415 * `limit(n)`
416 Returns a new `QueryCollection` that limits the size of the result
417 set to `n` items. Useful for pagination.
418 * `skip(n)`
419 Returns a new `QueryCollection` that skips the first `n` results.
420 Useful for pagination.
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
421 * `prefetch(rel)`
033f67a Added .limit(n) and .skip(n) support.
Zef Hemel authored
422 Returns a new `QueryCollection` that prefetches entities linked
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
423 through relationship `rel`, note that this only works for one-to-one
424 and many-to-one relationships.
a9fa189 @zefhemel Added `count` call to query collections. Fixed a little bug in
zefhemel authored
425 * `add(obj)`
426 Adds object `obj` to the collection.
427 * `remove(obj)`
428 Removes object `obj` from the collection.
e2d2c10 @zefhemel IMPORTANT: Minor breaking changes!
zefhemel authored
429 * `list([tx], callback)`
033f67a Added .limit(n) and .skip(n) support.
Zef Hemel authored
430 Asynchronously fetches the results matching the formulated query.
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
431 Once retrieved, the callback function is invoked with an array of
432 entity objects as argument.
e2d2c10 @zefhemel IMPORTANT: Minor breaking changes!
zefhemel authored
433 * `each([tx], eachCallback)`
9520607 Basic implementation of LocalQueryCollection, only supports filtering
Zef Hemel authored
434 Asynchronously fetches the results matching the formulated query.
435 Once retrieved, the `eachCallback` function is invoked on each
436 element of the result objects.
e2d2c10 @zefhemel IMPORTANT: Minor breaking changes!
zefhemel authored
437 * `forEach([tx], eachCallback)`
438 Alias for `each`
439 * `one([tx], callback)`
a2c07b5 @zefhemel Added `destroyAll` method to DbQueryCollections to remove all the items
zefhemel authored
440 Asynchronously fetches the first element of the collection, or `null` if none.
e2d2c10 @zefhemel IMPORTANT: Minor breaking changes!
zefhemel authored
441 * `destroyAll([tx], callback)`
a2c07b5 @zefhemel Added `destroyAll` method to DbQueryCollections to remove all the items
zefhemel authored
442 Asynchronously removes all the items in the collection. __Important__: this does
443 not only remove the items from the collection, but removes the items themselves!
e2d2c10 @zefhemel IMPORTANT: Minor breaking changes!
zefhemel authored
444 * `count([tx], callback)`
a9fa189 @zefhemel Added `count` call to query collections. Fixed a little bug in
zefhemel authored
445 Asynchronously counts the number of items in the collection. The arguments passed
446 to the `callback` function is the number of items.
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
447
448 Query collections are returned by:
449
450 * `EntityName.all()`, e.g. `Task.all()`
451 * one-to-many and many-to-many relationships, e.g. `task.tags`
452
453 Example:
cd6c915 Simple prefetching works.
zef authored
454
033f67a Added .limit(n) and .skip(n) support.
Zef Hemel authored
455 var allTasks = Task.all().filter("done", '=', true).prefetch("category").order("name", false).limit(10);
cd6c915 Simple prefetching works.
zef authored
456
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
457 allTasks.list(null, function (results) {
458 results.forEach(function (r) {
459 console.log(r.name)
460 window.task = r;
cd6c915 Simple prefetching works.
zef authored
461 });
462 });
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
463
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
464 Using persistence.js on the server
465 ==================================
466
dd1c7c4 @zefhemel Set-up library to be used a node library installable via npm. In fact,
zefhemel authored
467 Installing `persistence.js` on node is easy using [npm](http://npmjs.org):
468
469 npm install persistencejs
470
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
471 Sadly the node.js server environment requires slight changes to
472 `persistence.js` to make it work with multiple database connections:
473
474 * A `Session` object needs to be passed as an extra argument to
475 certain method calls, typically as a first argument.
476 * Methods previously called on the `persistence` object itself are now
477 called on the `Session` object.
478
479 An example `node.js` application is included in `test/node-blog.js`.
480
481 Setup
482 -----
483 You need to `require` two modules, the `persistence.js` library itself
dd1c7c4 @zefhemel Set-up library to be used a node library installable via npm. In fact,
zefhemel authored
484 and the MySQL backend module.
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
485
dd1c7c4 @zefhemel Set-up library to be used a node library installable via npm. In fact,
zefhemel authored
486 var persistence = require('persistencejs/persistence').persistence;
487 var persistenceStore = require('persistencejs/persistence.store.mysql');
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
488
489 Then, you configure the database settings to use:
490
8d922e1 @zefhemel Added port argument to documentation as well
zefhemel authored
491 persistenceStore.config(persistence, 'localhost', 3306, 'dbname', 'username', 'password');
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
492
493 Subsequently, for every connection you handle (assuming you're
494 building a sever), you call the `persistenceStore.getSession()`
495 method:
496
497 var session = persistenceBackend.getSession();
498
499 This session is what you pass around, typically together with a
500 transaction object. Note that currently you can only have one
501 transaction open per session and transactions cannot be nested.
502
503 session.transaction(function(tx) {
504 ...
505 });
506
507 Defining your data model
508 ------------------------
509
510 Defining your data model is done in exactly the same way as regular `persistence.js`:
511
512 var Task = persistence.define('Task', {
513 name: "TEXT",
514 description: "TEXT",
515 done: "BOOL"
516 });
517
518 A `schemaSync` is typically performed as follows:
519
520 session.schemaSync(tx, function() {
521 ...
522 });
523
524 Creating and manipulating objects
525 ---------------------------------
526
527 Creating and manipulating objects is done much the same way as with
528 regular `persistence.js`, except that in the entity's constructor you
529 need to reference the `Session` again:
530
531 var t = new Task(session);
532 ...
533 session.add(t);
534
535 session.flush(tx, function() {
536 ...
537 });
538
539 Query collections
b07a858 Moved issues to the issue tracker.
Zef Hemel authored
540 -----------------
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
541
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
542 Query collections work the same way as in regular `persistence.js`
543 with the exception of the `Entity.all()` method that now also requires
544 a `Session` to be passed to it:
545
546 Task.all(session).filter('done', '=', true).list(tx, function(tasks) {
547 ...
548 });
549
550 Closing the session
551 -------------------
552
553 After usage, you need to close your session:
554
555 session.close();
556
557 Bugs and Contributions
558 ======================
559
127d79b Rewrote parts of readme. Added documentation for supported property
Zef Hemel authored
560 If you find a bug, please [report it](http://yellowgrass.org/project/persistence.js).
c65213f Added Fabio's Date type to documentation.
Zef Hemel authored
561 or fork the project, fix the problem and send me a pull request. For
b07a858 Moved issues to the issue tracker.
Zef Hemel authored
562 a list of planned features and open issues, have a look at the [issue
b5cd840 Changed location of issue tracker.
Zef Hemel authored
563 tracker](http://yellowgrass.org/project/persistence.js).
033f67a Added .limit(n) and .skip(n) support.
Zef Hemel authored
564
0302c86 Added link to Google Group
Zef Hemel authored
565 For support and discussion, please join the [persistence.js Google
566 Group](http://groups.google.com/group/persistencejs).
567
0e32d43 @zefhemel Added AUTHORS file
zefhemel authored
568 Thanks goes to the people listed in `AUTHORS` for their contributions.
c65213f Added Fabio's Date type to documentation.
Zef Hemel authored
569
cda1de2 @zefhemel Added link to the persistence.js GWT wrapper.
zefhemel authored
570 If you use [GWT](http://code.google.com/webtoolkit/) (the Google Web
571 Toolkit), be sure to have a look at [Dennis Z. Jiang's GWT persistence.js
572 wrapper](http://github.com/dennisjzh/gwt-persistence).
573
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
574 License
4537c59 @zefhemel Rewrite and fixes to the README
zefhemel authored
575 =======
90ea29b Extended README + license. Preparing for initial release.
Zef Hemel authored
576
577 This work is licensed under the [MIT license](http://en.wikipedia.org/wiki/MIT_License).
cb16171 Added flattr link
Zef Hemel authored
578
579 Support this work
3d5d3f0 @zefhemel Fixes to node blogging example, and description of plug-ins added to
zefhemel authored
580 -----------------
cb16171 Added flattr link
Zef Hemel authored
581
582 You can support this project by flattering it:
583
584 <a href="http://flattr.com/thing/2510/persistence-js" target="_blank">
585 <img src="http://api.flattr.com/button/button-static-50x60.png" title="Flattr this" border="0" /></a>
Something went wrong with that request. Please try again.