Skip to content

Commit

Permalink
Improve doc on types
Browse files Browse the repository at this point in the history
  • Loading branch information
wdavidw committed Mar 5, 2012
1 parent 5d50d83 commit 70fa964
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions lib/Schema.coffee
Expand Up @@ -6,6 +6,21 @@ Schema
======
Define a new schema.
`ron` Reference to the Ron instance
`options` Schema definition. Options include:
* `name` Name of the schema.
* `properties` Properties definition, an object or an array.
Record properties may be defined by the following keys:
* `type` Use to cast the value inside Redis, one of `string`, `int` or `date`.
* `identifier` Mark this property as the identifier, only one property may be an identifier.
* `index` Create an index on the property.
* `unique` Create a unique index on the property.
* `email` Validate the string as an email.
Sample
------
Expand Down

0 comments on commit 70fa964

Please sign in to comment.