This is a basic store for IndexedDB. It implements dojo/store/api/Store.
| Parameter | Type | Description |
|---|---|---|
| options | Object |
Optional This provides any configuration information that will be mixed into the store |
Indicates the property to use as the identity property. The values of this property should be unique.
a hash of the preference of indices, indices that are likely to have very unique values should have the highest numbers as a reference, sorting is always set at 1, so properties that are higher than one will trigger filtering with index and then sort the whole set. we recommend setting boolean values at 0.1.
| Parameter | Type | Description |
|---|---|---|
| method | undefined | |
| args | undefined | |
| index | undefined | |
| returnRequest | undefined |
Adds an object.
| Parameter | Type | Description |
|---|---|---|
| object | Object | The object to store. |
| options | __PutDirectives |
Optional Additional metadata for storing the data. Includes an "id" property if a specific id is to be used. |
Retrieves an object by its identity.
| Parameter | Type | Description |
|---|---|---|
| id | Number | The identity to use to lookup the object |
Returns an object's identity
| Parameter | Type | Description |
|---|---|---|
| object | Object | The object to get the identity from |
Stores an object.
| Parameter | Type | Description |
|---|---|---|
| object | Object | The object to store. |
| options | __PutDirectives |
Optional Additional metadata for storing the data. Includes an "id" property if a specific id is to be used. |
Queries the store for objects.
| Parameter | Type | Description |
|---|---|---|
| query | Object | The query to use for retrieving objects from the store. |
| options | __QueryOptions |
Optional The optional arguments to apply to the resultset. |
The results of the query, extended with iterative methods.
Simple query engine that matches using filter functions, named filter functions or objects by name-value on a query object hash
The SimpleQueryEngine provides a way of getting a QueryResults through the use of a simple object hash as a filter. The hash will be used to match properties on data objects with the corresponding value given. In other words, only exact matches will be returned.
This function can be used as a template for more complex query engines; for example, an engine can be created that accepts an object hash that contains filtering functions, or a string that gets evaluated, etc.
When creating a new dojo.store, simply set the store's queryEngine field as a reference to this function.
| Parameter | Type | Description |
|---|---|---|
| query | Object | An object hash with fields that may match fields of items in the store. Values in the hash will be compared by normal == operator, but regular expressions or any object that provides a test() method are also supported and can be used to match strings by more complex expressions (and then the regex's or object's test() method will be used to match values). |
| options | dojo/store/api/Store.QueryOptions |
Optional An object that contains optional information such as sort, start, and count. |
A function that caches the passed query under the field "matches". See any of the "query" methods on dojo.stores.
Define a store with a reference to this engine, and set up a query method.
var myStore = function(options){
// ...more properties here
this.queryEngine = SimpleQueryEngine;
// define our query method
this.query = function(query, options){
return QueryResults(this.queryEngine(query, options)(this.data));
};
};
Deletes an object by its identity.
| Parameter | Type | Description |
|---|---|---|
| id | Number | The identity to use to delete the object |