Save, delete, or update an entity scoped document in NerdStorage. In order to successfully perform this operation, the user must have the right permissions.
Usage
import { EntityStorageMutation } from 'nr1'Examples
Write document
EntityStorageMutation.mutate({ entityGuid: 'MTIzNDU2fEZPT3xCQVJ8OTg3NjU0Mzcz', actionType: EntityStorageMutation.ACTION_TYPE.WRITE_DOCUMENT, collection: 'myCollection', documentId: 'myDocumentId', document: { name: 'John', surname: 'Doe', },});Delete document
EntityStorageMutation.mutate({ entityGuid: 'MTIzNDU2fEZPT3xCQVJ8OTg3NjU0Mzcz', actionType: EntityStorageMutation.ACTION_TYPE.DELETE_DOCUMENT, collection: 'myCollection', documentId: 'myDocumentId',});Delete collection
EntityStorageMutation.mutate({ entityGuid: 'MTIzNDU2fEZPT3xCQVJ8OTg3NjU0Mzcz', actionType: EntityStorageMutation.ACTION_TYPE.DELETE_COLLECTION, collection: 'myCollection',});Props
REQUIREDenum | Type of action to perform. <One of |
REQUIREDfunction | Render prop function as children. function ( |
REQUIREDstring | Collection name. |
object | NerdStorage document. Documents are restricted to 64 kB in size when JSON-stringified. |
string | Document identifier to operate in. When omitted the whole collection is returned. |
REQUIREDstring | GUID of the entity in which the collection is operated. |
boolean | Establishes whether the data needs to be scoped by actor or not; that is, whether the data read or saved is common to everybody having access to the object, or it is exclusive of the user.An object (entity or account) can have both "global" data and "scoped" data, and the data read will depend on the status of the flag. |
Methods
EntityStorageMutation.mutate
function (props: Object Object containing the mutation options. Any EntityStorageMutation prop is a valid option except children.
) => PromiseQueryResultType definitions
PromiseQueryResult
{error: ApolloClient.ApolloError, Runtime error with graphQLErrors and networkError properties.
data: Object, Object containing the result of your query.
fetchMore: function|null, If not null, fetchMore allows you to load more results for your query. New data is merged with previous data.
refetch: function, Refetch the query.
}MutationResult
{loading: boolean, Indicates that the request is in flight.
error: ApolloClient.ApolloError, Runtime error with graphQLErrors and networkError properties.
data: Object, Object containing the result of your mutation.
}