EntityStorageQuery

Query NerdStorage for entity scoped data.

Retrieve an entire collection or a single document.

Usage

import { EntityStorageQuery } from 'nr1'

Examples

Query collection

<EntityStorageQuery
  entityGuid="MTIzNDU2fEZPT3xCQVJ8OTg3NjU0Mzcz"
  collection="foo"
>
  {({ loading, error, data }) => {
    if (loading) {
      return <Spinner />;
    }


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


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

Query document

<EntityStorageQuery
  entityGuid="MTIzNDU2fEZPT3xCQVJ8OTg3NjU0Mzcz"
  collection="foo"
  documentId="bar"
>
  {({ loading, error, data }) => {
    if (loading) {
      return <Spinner />;
    }


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


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

Imperative query

EntityStorageQuery.query({
  entityGuid: 'MTIzNDU2fEZPT3xCQVJ8OTg3NjU0Mzcz',
  collection: 'myCollection',
  documentId: 'myDocumentId',
}).then(({ data }) => console.log(data));

Props

children

function

Render prop function as a child.

function (queryResult: QueryResult Results of the query.
) => React.ReactNode

collection

REQUIRED

string

Collection name.

documentId

string

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

entityGuid

REQUIRED

string

GUID of the entity in which the collection is operated.

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.
<One ofEntityStorageQuery.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, >

pollInterval

number

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

scopeByActor

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.

skip

boolean

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

Methods