Microsoft Garnet

RESP-compatible remote cache-store with optional cluster mode, append-only file and tiered storage.

Provider: default
Kind: Cache
Category: Data
Official docs: https://microsoft.github.io/garnet/docs/getting-started/configuration

Properties · 1 set by this component

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

Rules that apply · 3

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

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

Use it in a design

nodes:
  - { id: "garnet", component: "garnet" }

Other Cache products · 36

ApsaraDB for Memcachealibaba-apsaradb-memcachealibabacloudcache ApsaraDB for Redisalibaba-apsaradb-redisalibabacloudcache Amazon DynamoDB Accelerator (DAX)aws-daxawscache Amazon ElastiCacheaws-elasticacheawscache Amazon MemoryDBaws-memorydbawscache Azure Cache for Redisazure-cache-for-redisazurecache Azure Managed Redisazure-managed-redisazurecache Generic cachecachecache Cache clustercache-clustercache cogneecogneecache Dragonflydragonflycache EVCacheevcachecache VMware GemFiregemfirecache Graphitigraphiticache Hazelcasthazelcastcache Apache Igniteignitecache Infinispaninfinispancache KeyDBkeydbcache Lettalettacache Mem0mem0cache Memcachedmemcachedcache Redisrediscache Redis Cloudredis-cloudcache Squidsquidcache Trickstertrickstercache Upstash Redisupstashcache Valkeyvalkeycache Varnish Cachevarnishcache Zepzepcache Memorystore for Redisgoogle-memorystoregcpcache Memorystore for Memcachedgoogle-memorystore-memcachedgcpcache Memorystore for Redis Clustergoogle-memorystore-redis-clustergcpcache Memorystore for Valkeygoogle-memorystore-valkeygcpcache IBM Cloud Databases for Redisibm-databases-for-redisibmcache OCI Cache with Redisoci-cache-redisocicache OCI Cache with Valkeyoci-cache-valkeyocicache

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# Microsoft Garnet: RESP-compatible remote cache-store. The append-only file, cluster mode and TLS
3# are all disabled unless switched on, so a stock server is a volatile single node
4# ("Garnet configuration", "Welcome to Garnet").
5schemaVersion: "1"
6type: "component"
7id: "garnet"
8kind: "cache"
9provider: "default"
10docs: "https://microsoft.github.io/garnet/docs/getting-started/configuration"
11defaults:
12  persistence: false
13properties:
14  appendOnlyFile:
15    type: "boolean"
16    default: false
17  cluster:
18    type: "boolean"
19    default: false
20  tls:
21    type: "boolean"
22    default: false

The same page as markdown, for an agent: /catalogue/components/garnet.md