Cache

In-memory key-value store placed in front of a slower datastore.

Category: Data
Properties: 14
Components: 37
Rules: 3

Properties · 14 defined by this kind

A node of this kind resolves each property from its own props, then the component's defaults, then the default below.

property	type	values	required	default
evictionPolicy	enum	lru \| lfu \| ttl \| none	no	—
hashing · advanced	enum	none \| consistent	no	none
invalidation	enum	ttl \| event \| none	no	ttl
managed	boolean	—	no	false
materialised · advanced	boolean	—	no	false
persistence	boolean	—	no	false
readBarrier · advanced	boolean	—	no	false
replication	enum	none \| single-az \| multi-az \| multi-region	no	none
shards	integer	—	no	—
structure · advanced	enum	key-value \| bloom-filter \| hash-set \| sorted-set	no	key-value
tier · advanced	enum	core \| edge	no	core
ttlJitter · advanced	boolean	—	no	false
ttlSeconds	integer	—	no	—
usedAsPrimaryStore · advanced	boolean	—	no	false

Rules for this kind · 3

Cache used as primary store without persistenceerror

cache-as-primary-store-without-persistence

This cache is the only copy of its data and has persistence turned off. A restart loses the data outright.

— all of these hold:
— the node's `usedAsPrimaryStore` is true
— the node's `persistence` is false

Cache without eviction policywarning

cache-missing-eviction-policy

A cache with no declared eviction policy inherits whatever the vendor chose, and most vendors default to evicting nothing. The cache fills up and then starts refusing writes.

— any of these hold:
— the node's `evictionPolicy` has no value
— the node's `evictionPolicy` is "none"

Materialised cache without a rebuild patherror

materialised-cache-without-rebuild-path

A cache holding materialised views has to be rebuildable from a durable store or a worker. With nothing feeding it, a cold cache is a permanent gap rather than a slow start.

— all of these hold:
— the node's `materialised` is true
— this does not hold:
— the node has at least one incoming edge from a sql-database, nosql-database, worker or stream

Components · 37

vendor-neutral

Generic cachecachegenericthe kind itself

alibabacloud

ApsaraDB for Memcachealibaba-apsaradb-memcache4 defaults ApsaraDB for Redisalibaba-apsaradb-redis4 defaults

aws

Amazon DynamoDB Accelerator (DAX)aws-dax7 defaults Amazon ElastiCacheaws-elasticache5 defaults Amazon MemoryDBaws-memorydb6 defaults

azure

Azure Cache for Redisazure-cache-for-redis3 defaults Azure Managed Redisazure-managed-redis3 defaults

gcp

Memorystore for Redisgoogle-memorystore5 defaults Memorystore for Memcachedgoogle-memorystore-memcached5 defaults Memorystore for Redis Clustergoogle-memorystore-redis-cluster5 defaults Memorystore for Valkeygoogle-memorystore-valkey5 defaults

ibm

IBM Cloud Databases for Redisibm-databases-for-redis2 defaults

oci

OCI Cache with Redisoci-cache-redis3 defaults OCI Cache with Valkeyoci-cache-valkey3 defaults

Source

1# yaml-language-server: $schema=../schema/kind.schema.json
2# In-memory key-value store placed in front of a slower datastore.
3# evictionPolicy is deliberately optional with no default; cache-missing-eviction-policy reports its absence.
4# shards counts the identical shards of one cache; two or more draw the node as a stack.
5schemaVersion: "1"
6type: "kind"
7id: "cache"
8category: "data"
9properties:
10  evictionPolicy:
11    type: "enum"
12    values: ["lru", "lfu", "ttl", "none"]
13  ttlSeconds:
14    type: "integer"
15  ttlJitter:
16    type: "boolean"
17    default: false
18    advanced: true
19  persistence:
20    type: "boolean"
21    default: false
22  replication:
23    type: "enum"
24    values: ["none", "single-az", "multi-az", "multi-region"]
25    default: "none"
26  invalidation:
27    type: "enum"
28    values: ["ttl", "event", "none"]
29    default: "ttl"
30  hashing:
31    type: "enum"
32    values: ["none", "consistent"]
33    default: "none"
34    advanced: true
35  usedAsPrimaryStore:
36    type: "boolean"
37    default: false
38    advanced: true
39  materialised:
40    type: "boolean"
41    default: false
42    advanced: true
43  structure:
44    type: "enum"
45    values: ["key-value", "bloom-filter", "hash-set", "sorted-set"]
46    default: "key-value"
47    advanced: true
48  readBarrier:
49    type: "boolean"
50    default: false
51    advanced: true
52  tier:
53    type: "enum"
54    values: ["core", "edge"]
55    default: "core"
56    advanced: true
57  shards:
58    type: "integer"
59  managed:
60    type: "boolean"
61    default: false

The same page as markdown, for an agent: /catalogue/kinds/cache.md