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

Query NerdStorage for user scoped data.

Retrieve an entire collection or a single document.

### Usage

```jsx
import { UserStorageQuery } from 'nr1'
```

### Examples

#### Query collection

```jsx
<UserStorageQuery collection="foo">
  {({ loading, error, data }) => {
    if (loading) {
      return <Spinner />;
    }

    if (error) {
      return 'Error!';
    }

    return <pre>{JSON.stringify(data, null, 4)}</pre>;
  }}
</UserStorageQuery>
```

#### Query document

```jsx
<UserStorageQuery collection="foo" documentId="bar">
  {({ loading, error, data }) => {
    if (loading) {
      return <Spinner />;
    }

    if (error) {
      return 'Error!';
    }

    return <pre>{JSON.stringify(data, null, 4)}</pre>;
  }}
</UserStorageQuery>
```

#### Imperative query

```js
UserStorageQuery.query({
  collection: 'myCollection',
  documentId: 'myDocumentId',
}).then(({ data }) => console.log(data));
```

### Props

| `children` function         | Render prop function as a child.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `collection` REQUIREDstring | Collection name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `documentId` string         | Document identifier to operate in. When omitted the whole collection is returned.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `fetchPolicyType` enum      | Allows you to specify how you want your query to interact with the cached data. - `CACHE_AND_NETWORK`: The query returns your initial data from the cache if available. However, regardless of whether or not the full data is in your cache, the query always makes a request using your network interface and returns the updated data. This option is not available when using the static `query()` method of the component. - `CACHE_FIRST`: The query makes a request using your network interface **only** if the data for your query is not already in the cache. - `CACHE_ONLY`: The query **never** makes a request using your network interface. Instead it returns the data available in the cache. If the data for your query does not exist in the cache, then an error is thrown. - `NETWORK_ONLY`: The query **never** returns your initial data from the cache. Instead it **always** makes a request using your network interface. - `NO_CACHE`: The query **never** returns your initial data from the cache. Instead it **always** makes a request using your network interface. Unlike the `NETWORK_ONLY` policy, it does not write any data to the cache after the query completes. UserStorageQuery.FETCH_POLICY_TYPE.CACHE_AND_NETWORK, UserStorageQuery.FETCH_POLICY_TYPE.CACHE_FIRST, UserStorageQuery.FETCH_POLICY_TYPE.CACHE_ONLY, UserStorageQuery.FETCH_POLICY_TYPE.NETWORK_ONLY, UserStorageQuery.FETCH_POLICY_TYPE.NO_CACHE, |
| `pollInterval` number       | Interval in milliseconds to poll for new data. Set to zero to avoid any kind of regular polling.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `skip` boolean              | When set to `true`, the query will be skipped entirely from rendering.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

### Methods

### `UserStorageQuery.query`

### Type definitions