EntityStorageQuery

Interroge NerdStorage pour les données à l’échelle de l’entité.

Récupérer une collection entière ou un seul document.

Usage

import { EntityStorageQuery } from 'nr1';

Exemples

Collection de requêtes

<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>;

Document de requête

<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>;

Requête impérative

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

Accessoires

children

fonction

Rendre la fonction prop comme un enfant.

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

collection

OBLIGATOIRE

chaîne

Nom de la collection.

documentId

chaîne

Document identifiant pour opérer. En cas d'omission, la collection entière est renvoyée.

entityGuid

OBLIGATOIRE

chaîne

GUID de l'entité dans laquelle la collection est exploitée.

fetchPolicyType

énum.

Vous permet de spécifier comment vous souhaitez que votre requête interagisse avec les données mises en cache.

CACHE_AND_NETWORK: La requête renvoie vos données initiales du cache si elles sont disponibles. Cependant, que les données complètes soient ou non dans votre cache, la requête effectue toujours une demande à l'aide de votre interface réseau et renvoie les données mises à jour. Cette option n'est pas disponible lors de l'utilisation de la méthode statique query() du composant.
CACHE_FIRST: La requête effectue une demande à l'aide de votre interface réseau uniquement si les données de votre requête ne sont pas déjà dans le cache.
CACHE_ONLY: La requête n'effectue jamais de demande à l'aide de votre interface réseau. Au lieu de cela, il renvoie les données disponibles dans le cache. Si les données de votre requête n'existent pas dans le cache, une erreur est générée.
NETWORK_ONLY: La requête ne renvoie jamais vos données initiales à partir du cache. Au lieu de cela, il fait toujours une demande en utilisant votre interface réseau.
NO_CACHE: La requête ne renvoie jamais vos données initiales à partir du cache. Au lieu de cela, il fait toujours une demande en utilisant votre interface réseau. Contrairement à la politique NETWORK_ONLY, aucune donnée n'est écrite dans le cache une fois la requête terminée.
<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

nombre

Intervalle en millisecondes pour interroger de nouvelles données. Réglez à zéro pour éviter tout type d'interrogation régulière.

scopeByActor

booléen

Établit si les données doivent être limitées par l'acteur ou non ; c'est-à-dire si les données lues ou enregistrées sont communes à tous ceux qui ont accès à l'objet, ou si elles sont exclusives à l'utilisateur. Un objet (entité ou compte) peut avoir à la fois des données « globales » et des données « limitées », et les données lues dépendront de l'état de l'indicateur.

skip

booléen

Lorsqu'il est défini sur true, la requête sera entièrement ignorée du rendu.

Méthodes