[#168,docs/backend][s]: bring backend example up to date.

This commit is contained in:
Rufus Pollock
2012-06-29 15:49:43 +01:00
parent 0e50e99c59
commit 12f6afebc9
2 changed files with 13 additions and 10 deletions

View File

@@ -11,11 +11,19 @@ root: ../
</h1>
</div>
Backends connect Dataset and Documents to data from a specific 'Backend' data
source. They provide methods for loading and saving Datasets and individuals
Documents as well as for bulk loading via a query API and doing bulk transforms
on the backend.
Backends come in 2 flavours:
1. Loader backends - only implement fetch method. The data is then cached in a Memory.Store on the Dataset and interacted with there. This is best for sources which just allow you to load data or where you want to load the data once and work with it locally.
2. Store backends - these support fetch, query and, if write-enabled, save. These are suitable where the backend contains a lot of data (infeasible to load locally - for examples a million rows) or where the backend has capabilities you want to take advantage of.
# Backend API
Backend modules must implement the following API:
{% highlight javascript %}