Creating a data store

Creating a data store

Data stores act as a powerful NoSQL document storage system, with the ability to create cached views based on sorting one or more fields.

Prepare an Object

var app  = $.data({id: "app"}, null, {key: "name"});

Set the records

If the Objects in the Array do not have a property matching app.data.key the Array index value will be used.

// Discarding observer events to minimize latency
$.discard(true);

// Batching in records
app.data.batch("set", recordsArray);

// Enabling observer events for GUI
$.discard(false);

Get a record

Getting a record can be achieved by passing the data.key value, or the Array index.

var record = app.data.get("abc-123");

Getting multiple records

Getting a record set requires passing a second parameter, the number of records to retrieve from the index for the first parameter.

// 5 records (e.g. pagination)
var records = app.data.get(0, 5);

Updating a record

Updating a record will erase views.

// Record scope
record.set("someProperty", value);

// Data store scope
app.data.set("abc-123", {"someProperty": value});

Deleting a record

Deleting a record will remove the record(s) from the data store, erase views and reindex the records.

// Record scope
record.del();

// Data store scope
app.data.del("abc-123");

Clearing a data store

Clearing a data store will clear data.records, data.views and reset data.total.

// Resetting the store
app.data.clear();

// Soft reset, leaves RESTful properties as is
app.data.clear(true);