Class Cache

Pamięć podręczna

Odwołanie do konkretnej pamięci podręcznej.

Ta klasa umożliwia wstawianie, pobieranie i usuwanie elementów z pamięci podręcznej. Może to być szczególnie przydatne, gdy chcesz często korzystać z drogiego lub wolnego zasobu. Załóżmy, że masz kanał RSS w witrynie example.com, którego pobieranie zajmuje 20 sekund, ale chcesz przyspieszyć dostęp do średniego żądania.

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

W przypadku, gdy element nie znajduje się w pamięci podręcznej, nadal trzeba będzie odczekać 20 sekund, ale kolejne wywołania będą bardzo szybkie, dopóki element nie wygaśnie i nie zostanie usunięty z pamięci podręcznej po 25 minutach.

Metody

Metoda	Zwracany typ	Krótki opis
get(key)	String	Pobiera wartość z poziomu pamięci podręcznej dla danego klucza lub null, jeśli nie znaleziono żadnej wartości.
getAll(keys)	Object	Zwraca obiekt JavaScript zawierający wszystkie pary klucz-wartość znalezione w pamięci podręcznej dla tablicy kluczy.
put(key, value)	void	Dodaje do pamięci podręcznej parę klucz-wartość.
put(key, value, expirationInSeconds)	void	Dodaje parę klucz-wartość do pamięci podręcznej z czasem wygaśnięcia (w sekundach).
putAll(values)	void	Dodaje do pamięci podręcznej zestaw par klucz-wartość.
putAll(values, expirationInSeconds)	void	Dodaje do pamięci podręcznej zestaw par klucz-wartość z czasem wygaśnięcia (w sekundach).
remove(key)	void	Usuwa wpis z pamięci podręcznej przy użyciu podanego klucza.
removeAll(keys)	void	Usuwa z pamięci podręcznej zbiór wpisów.

Szczegółowa dokumentacja

get(key)

Pobiera wartość z poziomu pamięci podręcznej dla danego klucza lub null, jeśli nie znaleziono żadnej wartości.

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

Parametry

Nazwa	Typ	Opis
key	String	klucz do wyszukania w pamięci podręcznej,

Powrót

String – wartość z poziomu pamięci podręcznej lub null, jeśli nie znaleziono żadnej wartości

---

getAll(keys)

Zwraca obiekt JavaScript zawierający wszystkie pary klucz-wartość znalezione w pamięci podręcznej dla tablicy kluczy.

// Gets a set of values from the cache
const values = CacheService.getDocumentCache().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'}

Parametry

Nazwa	Typ	Opis
keys	String[]	klucze do wyszukiwania,

Powrót

Object – obiekt JavaScript zawierający pary klucz-wartość wszystkich kluczy znalezionych w pamięci podręcznej.

Zobacz też

• get(key)

---

put(key, value)

Dodaje do pamięci podręcznej parę klucz-wartość.

Maksymalna długość klucza to 250 znaków. Maksymalna ilość danych, które można przechowywać na klucz, to 100 KB. Wartość wygasa z pamięci podręcznej po 600 sekundach (10 minut).

Limit elementów w pamięci podręcznej to 1000. Jeśli zapisano ponad 1000 elementów,pamięć podręczna przechowuje 900 elementów, które są najdalej od daty wygaśnięcia. Ten limit może się zmienić.

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

Parametry

Nazwa	Typ	Opis
key	String	klucz, pod którym ma być przechowywana wartość;
value	String	wartość do umieszczenia w pamięci podręcznej.

---

put(key, value, expirationInSeconds)

Dodaje parę klucz-wartość do pamięci podręcznej z czasem wygaśnięcia (w sekundach).

Maksymalna długość klucza to 250 znaków. Maksymalna ilość danych, które można przechowywać na klucz, to 100 KB. Okres ważności określony w sposób domyślny to tylko sugestia. Jeśli w pamięci podręcznej jest dużo danych, mogą one zostać usunięte przed tym czasem.

Limit elementów w pamięci podręcznej to 1000. Jeśli zapisano ponad 1000 elementów,pamięć podręczna przechowuje 900 elementów, które są najdalej od daty wygaśnięcia. Ten limit może się zmienić.

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

Parametry

Nazwa	Typ	Opis
key	String	klucz, pod którym ma być przechowywana wartość;
value	String	wartość do umieszczenia w pamięci podręcznej.
expirationInSeconds	Integer	maksymalny czas (w sekundach), przez jaki wartość pozostaje w pamięci podręcznej. Minimalny czas to 1 sekunda, a maksymalny – 21 600 sekund (6 godzin).

---

putAll(values)

Dodaje do pamięci podręcznej zestaw par klucz-wartość.

Jest to podobne do powtarzających się wywołań metody „put”, ale bardziej wydajne, ponieważ wywołuje tylko 1 raz serwer memcache, aby ustawić wszystkie wartości. Maksymalna długość klucza to 250 znaków. Maksymalna ilość danych, które można przechowywać na klucz, wynosi 100 KB. Wartości zostaną usunięte z pamięci podręcznej po 600 sekundach (10 minutach).

Limit elementów w pamięci podręcznej to 1000. Jeśli zapisano ponad 1000 elementów,pamięć podręczna przechowuje 900 elementów, które są najdalej od daty wygaśnięcia. Ten limit może się zmienić.

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

Parametry

Nazwa	Typ	Opis
values	Object	obiekt JavaScript zawierający klucze i wartości ciągu znaków;

Zobacz też

• put(key, value)

---

putAll(values, expirationInSeconds)

Dodaje do pamięci podręcznej zestaw par klucz-wartość z czasem wygaśnięcia (w sekundach).

Jest to podobne do powtarzających się wywołań metody „put”, ale bardziej wydajne, ponieważ wywołuje tylko 1 raz serwer memcache, aby ustawić wszystkie wartości. Maksymalna długość klucza to 250 znaków. Maksymalna ilość danych, które można przechowywać na klucz, wynosi 100 KB. Okres ważności jest tylko sugestią. Dane w pamięci podręcznej mogą zostać usunięte przed tym czasem, jeśli jest ich dużo.

Limit elementów w pamięci podręcznej to 1000. Jeśli zapisano ponad 1000 elementów,pamięć podręczna przechowuje 900 elementów, które są najdalej od daty wygaśnięcia. Ten limit może się zmienić.

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

Parametry

Nazwa	Typ	Opis
values	Object	Obiekt JavaScriptu zawierający klucze i wartości ciągu znaków
expirationInSeconds	Integer	Maksymalny czas przechowywania wartości w pamięci podręcznej (w sekundach). Minimalny dozwolony czas ważności to 1 sekunda, a maksymalny – 21600 sekund (6 godzin). Domyślny czas wygaśnięcia to 600 sekund (10 minut).

Zobacz też

• put(key, value)

---

remove(key)

Usuwa wpis z pamięci podręcznej przy użyciu podanego klucza.

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

Parametry

Nazwa	Typ	Opis
key	String	klucz, który chcesz usunąć z pamięci podręcznej.

---

removeAll(keys)

Usuwa z pamięci podręcznej zbiór wpisów.

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

Parametry

Nazwa	Typ	Opis
keys	String[]	tablica kluczy do usunięcia