Function
This is an abstract API that data provider implementations conform to. This file defines methods signatures and intentionally leaves all the methods unimplemented. For more information on the dojo.store APIs, please visit: http://dojotoolkit.org/reference-guide/dojo/store.html Every method and property is optional, and is only needed if the functionality it provides is required. Every method may return a promise for the specified return value if the execution of the operation is asynchronous (except for query() which already defines an async return value).
String
If the store has a single primary key, this tndicates the property to use as the identity property. The values of this property should be unique.
Function
If the store can be queried locally (on the client side in JS), this defines the query engine to use for querying the data store. This takes a query and query options and returns a function that can execute the provided query on a JavaScript array. The queryEngine may be replace to provide more sophisticated querying capabilities. For example: var query = store.queryEngine({foo:"bar"}, {count:10}); query(someArray) -> filtered array The returned query function may have a "matches" property that can be used to determine if an object matches the query. For example: query.matches({id:"some-object", foo:"bar"}) -> true query.matches({id:"some-object", foo:"something else"}) -> false
Function
The identity to use to lookup the object
Retrieves an object by its identity
Object The object in the store that matches the given id.
Function
The object to get the identity from
Returns an object's identity
String|Number
Function
The object to store.
Additional directives for storing objects.
Stores an object
Number|String
Function
The object to store.
Additional directives for creating objects.
Creates an object, throws an error if the object already exists
Number|String
Function
The identity to use to delete the object
Deletes an object by its identity
Function
The query to use for retrieving objects from the store.
The optional arguments to apply to the resultset.
Queries the store for objects. This does not alter the store, but returns a set of data from the store.
dojo.store.api.Store.QueryResults The results of the query, extended with iterative methods.
Given the following store: ...find all items where "prime" is true: store.query({ prime: true }).forEach(function(object){ // handle each object });
Function
Starts a new transaction. Note that a store user might not call transaction() prior to using put, delete, etc. in which case these operations effectively could be thought of as "auto-commit" style actions.
dojo.store.api.Store.Transaction This represents the new current transaction.
Function
The object to find the children of.
Additional options to apply to the retrieval of the children.
Retrieves the children of an object.
dojo.store.api.Store.QueryResults A result set of the children of the parent object.
Function
The object to return metadata for.
Returns any metadata about the object. This may include attribution, cache directives, history, or version information.
Object An object containing metadata.
Function
This is an object returned from query() calls that provides access to the results of a query. Queries may be executed asynchronously.
Function
that is called for each object in the query results
object to use as |this| in the callback.
Iterates over the query results, based on https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach. Note that this may executed asynchronously. The callback may be called after this function returns.
Function
that is called for each object in the query results
object to use as |this| in the callback.
Filters the query results, based on https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/filter. Note that this may executed asynchronously. The callback may be called after this function returns.
dojo.store.api.Store.QueryResults
Function
that is called for each object in the query results
object to use as |this| in the callback.
Maps the query results, based on https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map. Note that this may executed asynchronously. The callback may be called after this function returns.
dojo.store.api.Store.QueryResults
Function
is called when the query is completed successfully, and is passed a single argument that is an array representing the query results.
is called if the query failed, and is passed a single argument that is the error for the failure.
This registers a callback for when the query is complete, if the query is asynchronous. This is an optional method, and may not be present for synchronous queries.
Function
The listener function is called when objects in the query results are modified to affect the query result. The listener function is called with the following arguments: listener(object, removedFrom, insertedInto); * The object parameter indicates the object that was create, modified, or deleted. * The removedFrom parameter indicates the index in the result array where the object used to be. If the value is -1, then the object is an addition to this result set (due to a new object being created, or changed such that it is a part of the result set). * The insertedInto parameter indicates the index in the result array where the object should be now. If the value is -1, then the object is a removal from this result set (due to an object being deleted, or changed such that it is not a part of the result set).
indicates whether or not to include object updates that do not affect the inclusion or order of the object in the query results. By default this is false, which means that if any object is updated in such a way that it remains in the result set and it's position in result sets is not affected, then the listener will not be fired.
This registers a callback for notification of when data is modified in the query results. This is an optional method, and is usually provided by dojo.store.Observable.
Number|Promise
This property should be included in if the query options included the "count" property limiting the result set. This property indicates the total number of objects matching the query (as if "start" and "count" weren't present). This may be a promise if the query is asynchronous.
Function
This is an object returned from transaction() calls that represents the current transaction.
Function
Commits the transaction. This may throw an error if it fails. Of if the operation is asynchronous, it may return a promise that represents the eventual success or failure of the commit.
Function
Aborts the transaction. This may throw an error if it fails. Of if the operation is asynchronous, it may return a promise that represents the eventual success or failure of the abort.
Function
Indicates the identity of the object if a new object is created
If the collection of objects in the store has a natural ordering, this indicates that the created or updated object should be placed before the object specified by the value of this property. A value of null indicates that the object should be last.
If the store is hierarchical (with single parenting) this property indicates the new parent of the created or updated object.
If this is provided as a boolean it indicates that the object should or should not overwrite an existing object. A value of true indicates that a new object should not be created, the operation should update an existing object. A value of false indicates that an existing object should not be updated, a new object should be created (which is the same as an add() operation). When this property is not provided, either an update or creation is acceptable.
Directives passed to put() and add() handlers for guiding the update and creation of stored objects.
String|Number?
Indicates the identity of the object if a new object is created
Object?
If the collection of objects in the store has a natural ordering, this indicates that the created or updated object should be placed before the object specified by the value of this property. A value of null indicates that the object should be last.
Object?
If the store is hierarchical (with single parenting) this property indicates the new parent of the created or updated object.
Boolean?
If this is provided as a boolean it indicates that the object should or should not overwrite an existing object. A value of true indicates that a new object should not be created, the operation should update an existing object. A value of false indicates that an existing object should not be updated, a new object should be created (which is the same as an add() operation). When this property is not provided, either an update or creation is acceptable.
Function
The name of the attribute to sort on.
The direction of the sort. Default is false.
An object describing what attribute to sort on, and the direction of the sort.
String
The name of the attribute to sort on.
Boolean
The direction of the sort. Default is false.
Function
A list of attributes to sort on, as well as direction For example: [{attribute:"price, descending: true}]. If the sort parameter is omitted, then the natural order of the store may be applied if there is a natural order.
The first result to begin iteration on
The number of how many results should be returned.
Optional object with additional parameters for query results.
dojo.store.api.Store.SortInformation[]?
A list of attributes to sort on, as well as direction For example: [{attribute:"price, descending: true}]. If the sort parameter is omitted, then the natural order of the store may be applied if there is a natural order.
Number?
The first result to begin iteration on
Number?
The number of how many results should be returned.
Object
Object
Object