794ed25819
It looks better than the half-organization we had so far, and it will actually make it easier for editorial changes to come. Also keeps us more honest about doing it sooner rather than later. Change-Id: I6303325f6d75389c7e8ca908f3740cf92af3836a |
||
|---|---|---|
| .. | ||
| README.md | ||
| TODO | ||
| attributes.md | ||
| blob-magic.md | ||
| bytes.md | ||
| common.md | ||
| delete.md | ||
| directory.md | ||
| fifo.md | ||
| file.md | ||
| inode.md | ||
| keep.md | ||
| permanode.md | ||
| share.md | ||
| socket.md | ||
| static-set.md | ||
| symlink.md | ||
README.md
Schema
At the lowest layer, Camlistore doesn't care what you put in it (everything is just dumb bytes) and you're free to adopt your own data model. However, the upper layers of Camlistore standardize on a common schema to represent various classes of data.
Schema blobs are JSON objects with at least two attributes always set:
camliVersion, which is always 1, and camliType, which tells you the type of
metadata the blob contains.
Here are some of the data types we've started to formalize a JSON schema for:
-
Files: traditional filesystems. Files, directories, inodes, symlinks, etc. Uses the
file,directory,symlink, andinodecamliTypes. -
"Keep" claims: Normally, any object that isn't referenced by a permanode could theoretically be garbage collected. Keep claims prevent that from happening. Indicated by the
keepcamliType. -
Permanodes: the immutable root "anchor" of mutable Camlistore objects (see terminology). Users create signed claim schema blobs which reference a permanode and define some mutation for the permanode.
Permanodes are used to model many kinds of mutable data, including mutable files, dynamic directories, and more.
Uses the
permanodeandclaimcamliTypes. -
Static Sets: Immutable lists of other blobs by their refs. Indicated by the
static-setcamliType.