Cette page a été traduite par l'API Cloud Translation.

Class Cache

Référence à un cache particulier.

Cette classe vous permet d'insérer, de récupérer et de supprimer des éléments d'un cache. Cela peut être particulièrement utile lorsque vous souhaitez accéder fréquemment à une ressource coûteuse ou lente. Par exemple, supposons que la récupération d'un flux RSS sur example.com prenne 20 secondes, mais que vous souhaitiez accélérer l'accès pour une requête moyenne.

function getRssFeed() {
  var cache = CacheService.getScriptCache();
  var cached = cache.get("rss-feed-contents");
  if (cached != null) {
    return cached;
  }
  var result = UrlFetchApp.fetch("http://example.com/my-slow-rss-feed.xml"); // takes 20 seconds
  var contents = result.getContentText();
  cache.put("rss-feed-contents", contents, 1500); // cache for 25 minutes
  return contents;
}

Vous devrez toujours attendre les 20 secondes si l'élément ne se trouve pas dans le cache, mais les appels suivants seront très rapides jusqu'à ce que l'élément expire du cache au bout de 25 minutes.

Méthodes

Méthode	Type renvoyé	Brève description
`get(key)`	`String`	Récupère la valeur mise en cache pour la clé donnée, ou la valeur null si aucune valeur n'est trouvée.
`getAll(keys)`	`Object`	Renvoie un objet JavaScript contenant toutes les paires clé/valeur trouvées dans le cache pour un tableau de clés.
`put(key, value)`	`void`	Ajoute une paire clé/valeur au cache.
`put(key, value, expirationInSeconds)`	`void`	Ajoute une paire clé/valeur au cache, avec un délai d'expiration (en secondes).
`putAll(values)`	`void`	Ajoute un ensemble de paires clé/valeur au cache.
`putAll(values, expirationInSeconds)`	`void`	Ajoute un ensemble de paires clé/valeur au cache, avec un délai d'expiration (en secondes).
`remove(key)`	`void`	Supprime une entrée du cache à l'aide de la clé donnée.
`removeAll(keys)`	`void`	Supprime un ensemble d'entrées du cache.

Documentation détaillée

`get(key)`

Récupère la valeur mise en cache pour la clé donnée, ou la valeur null si aucune valeur n'est trouvée.

// Gets the value from the cache for the key 'foo'.
var value = cache.get('foo');

Paramètres

Nom	Type	Description
`key`	`String`	la clé à rechercher dans le cache,

Renvois

String : valeur mise en cache, ou valeur "null" si aucune valeur n'a été trouvée

`getAll(keys)`

Renvoie un objet JavaScript contenant toutes les paires clé/valeur trouvées dans le cache pour un tableau de clés.

// Gets a set of values from the cache
var values = cache.getAll(['foo', 'x', 'missing']);
// If there were values in the cache for 'foo' and 'x' but not 'missing', then 'values' would
// be: {'foo': 'somevalue', 'x': 'othervalue'}

Paramètres

Nom	Type	Description
`keys`	`String[]`	les clés pour rechercher

Renvois

Object : objet JavaScript contenant les paires clé/valeur de toutes les clés trouvées dans le cache.

Voir aussi

get(key)

`put(key, value)`

Ajoute une paire clé/valeur au cache.

La longueur maximale d'une clé est de 250 caractères. La quantité maximale de données pouvant être stockées par clé est de 100 Ko. La valeur expire du cache après 600 secondes (10 minutes).

La limite pour les éléments mis en cache est de 1 000. Si plus de 1 000 éléments sont écrits, le cache les stocke avant la date d'expiration. Cette limite est susceptible de changer.

// Puts the value 'bar' into the cache using the key 'foo'
cache.put('foo', 'bar');

Paramètres

Nom	Type	Description
`key`	`String`	la clé permettant de stocker la valeur
`value`	`String`	la valeur à mettre en cache

`put(key, value, expirationInSeconds)`

Ajoute une paire clé/valeur au cache, avec un délai d'expiration (en secondes).

La longueur maximale d'une clé est de 250 caractères. La quantité maximale de données pouvant être stockées par clé est de 100 Ko. Le délai d'expiration spécifié n'est qu'une suggestion. Les données mises en cache peuvent être supprimées avant ce délai si une grande quantité de données est mise en cache.

La limite pour les éléments mis en cache est de 1 000. Si plus de 1 000 éléments sont écrits, le cache les stocke avant la date d'expiration. Cette limite est susceptible de changer.

// Puts the value 'bar' into the cache using the key 'foo', but only for the next 20 seconds.
cache.put('foo', 'bar', 20);

Paramètres

Nom	Type	Description
`key`	`String`	la clé permettant de stocker la valeur
`value`	`String`	la valeur à mettre en cache
`expirationInSeconds`	`Integer`	Durée maximale de conservation de la valeur dans le cache, en secondes. La valeur minimale est de 1 seconde et la valeur maximale de 21 600 secondes (6 heures).

`putAll(values)`

Ajoute un ensemble de paires clé/valeur au cache.

Semblable aux appels répétés à "put", mais plus efficace, car il n'effectue qu'un seul appel au serveur Memcache pour définir toutes les valeurs. La longueur maximale d'une clé est de 250 caractères. La quantité maximale de données pouvant être stockées par clé est de 100 Ko. Les valeurs expirent du cache après 600 secondes (10 minutes).

La limite pour les éléments mis en cache est de 1 000. Si plus de 1 000 éléments sont écrits, le cache les stocke avant la date d'expiration. Cette limite est susceptible de changer.

// Puts a set of values into the cache with the keys 'foo', 'x', and 'key'.
var values = {
  'foo': 'bar',
  'x':'y',
  'key': 'value'
};
cache.putAll(values);

Paramètres

Nom	Type	Description
`values`	`Object`	Objet JavaScript contenant des clés et des valeurs de type chaîne

Voir aussi

put(key, value)

`putAll(values, expirationInSeconds)`

Ajoute un ensemble de paires clé/valeur au cache, avec un délai d'expiration (en secondes).

Semblable aux appels répétés à "put", mais plus efficace, car il n'effectue qu'un seul appel au serveur Memcache pour définir toutes les valeurs. La longueur maximale d'une clé est de 250 caractères. La quantité maximale de données pouvant être stockées par clé est de 100 Ko. Le délai d'expiration spécifié n'est qu'une suggestion. Les données mises en cache peuvent être supprimées avant ce délai si une grande quantité de données est mise en cache.

La limite pour les éléments mis en cache est de 1 000. Si plus de 1 000 éléments sont écrits, le cache les stocke avant la date d'expiration. Cette limite est susceptible de changer.

// Puts a set of values into the cache with the keys 'foo', 'x', and 'key'.
var values = {
  'foo': 'bar',
  'x':'y',
  'key': 'value'
};
cache.putAll(values, 20);

Paramètres

Nom	Type	Description
`values`	`Object`	Objet JavaScript contenant des clés et des valeurs de type chaîne
`expirationInSeconds`	`Integer`	Durée maximale de conservation de la valeur dans le cache, en secondes. Le délai d'expiration minimal autorisé est de 1 seconde, et le délai d'expiration maximal autorisé est de 21 600 secondes (six heures). Le délai d'expiration par défaut est de 600 secondes (10 minutes).

Voir aussi

put(key, value)

`remove(key)`

Supprime une entrée du cache à l'aide de la clé donnée.

// Removes any cache entries for 'foo'
cache.remove('foo');

Paramètres

Nom	Type	Description
`key`	`String`	la clé à supprimer du cache,

`removeAll(keys)`

Supprime un ensemble d'entrées du cache.

// Removes entries from the cache with keys 'foo' and 'x'
cache.removeAll(['foo', 'x']);

Paramètres

Nom	Type	Description
`keys`	`String[]`	tableau de clés à supprimer