• /
  • Log in

EntityStorageQuery

Query NerdStorage for entity scoped data.

Retrieve an entire collection or a single document.

Usage

import { EntityStorageQuery } from 'nr1'

Examples

Props

childrenfunction

Render prop function as a child.

function (
queryResult: {Object //

Results of the query.

) => undefined
collectionrequiredstring

Collection name.

documentIdstring

Document identifier to operate in. When omitted the whole collection is returned.

entityGuidrequiredstring

GUID of the entity in which the collection is operated.

fetchPolicyTypeenum
DEFAULT
EntityStorageQuery.FETCH_POLICY_TYPE.CACHE_AND_NETWORK

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.

<One of
EntityStorageQuery.FETCH_POLICY_TYPE.CACHE_AND_NETWORK,
EntityStorageQuery.FETCH_POLICY_TYPE.CACHE_FIRST,
EntityStorageQuery.FETCH_POLICY_TYPE.CACHE_ONLY,
EntityStorageQuery.FETCH_POLICY_TYPE.NETWORK_ONLY,
EntityStorageQuery.FETCH_POLICY_TYPE.NO_CACHE,
>
pollIntervalnumber
DEFAULT
0

Interval in milliseconds to poll for new data. Set to zero to avoid any kind of regular polling.

skipboolean
DEFAULT
false

When set to true, the query will be skipped entirely from rendering.

Methods

EntityStorageQuery.render

function () => undefined

EntityStorageQuery.query

A static method to use EntityStorageQuery as a Promise instead of as a React component.

function (
props: Object //

An object containing the query options. Any EntityStorageQuery prop is a valid option except children and pollInterval.

) => {Object}

Type definitions

PromiseQueryResult

{
loading: boolean, //

Indicates that the request is in flight.

data: Object, //

An object containing the result of your query.

}
Create issueEdit page
Copyright © 2021 New Relic Inc.