---
title: UserStorageMutation
source: https://docs.newrelic.com/docs/new-relic-solutions/build-nr-ui/sdk-component/query-and-storage/UserStorageMutation
---

Save, delete, or update a user scoped document in NerdStorage.

### Usage

```js
import { UserStorageMutation } from 'nr1'
```

### Examples

#### Write document

```js
UserStorageMutation.mutate({
  actionType: UserStorageMutation.ACTION_TYPE.WRITE_DOCUMENT,
  collection: 'myCollection',
  documentId: 'myDocumentId',
  document: {
    name: 'John',
    surname: 'Doe',
  },
});
```

#### Delete document

```js
UserStorageMutation.mutate({
  actionType: UserStorageMutation.ACTION_TYPE.DELETE_DOCUMENT,
  collection: 'myCollection',
  documentId: 'myDocumentId',
});
```

#### Delete collection

```js
UserStorageMutation.mutate({
  actionType: UserStorageMutation.ACTION_TYPE.DELETE_COLLECTION,
  collection: 'myCollection',
});
```

### Props

| `actionType` REQUIREDenum   | Type of action to perform. UserStorageMutation.ACTION_TYPE.DELETE_COLLECTION, UserStorageMutation.ACTION_TYPE.DELETE_DOCUMENT, UserStorageMutation.ACTION_TYPE.WRITE_DOCUMENT, |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `children` REQUIREDfunction | Render prop function as children.                                                                                                                                              |
| `collection` string         | Collection name.                                                                                                                                                               |
| `document` object           | NerdStorage document. Documents are restricted to 64 kB in size when JSON-stringified.                                                                                         |
| `documentId` string         | Document identifier to operate in. When omitted the whole collection is returned.                                                                                              |

### Methods

### `UserStorageMutation.mutate`

### Type definitions