Skip to content

Commit 31ba805

Browse files
authored
Update README.md
1 parent c0545f9 commit 31ba805

File tree

1 file changed

+7
-5
lines changed
  • foundations/claim_check_pattern_python

1 file changed

+7
-5
lines changed

foundations/claim_check_pattern_python/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Claim Check Pattern with Temporal
22

3-
This recipe demonstrates how to use the Claim Check pattern to efficiently handle large payloads in Temporal workflows by storing them externally and passing only keys through the system.
3+
This recipe demonstrates how to use the Claim Check pattern to offload data from Temporal Server's Event History to external storage. This can be useful in conversational AI applications that include the full conversation history with each LLM call, creating large Event History that can exceed server size limits.
44

55
## What is the Claim Check Pattern?
66

7-
The Claim Check pattern allows you to work with large data in Temporal workflows without hitting payload size limits or performance issues. Instead of passing large payloads directly through Temporal, the pattern:
7+
Each Temporal Workflow has an associated Event History that is stored in Temporal Server and used to provide durable execution. When using the Claim Check pattern, we store the payload content of the Event in separate storage system, then store a reference to that storage in the Temporal Event History instead.
88

9-
1. Stores large payloads in external storage (Redis, S3, etc.)
10-
2. Replaces the payload with a unique key
11-
3. Automatically retrieves the original payload when needed
9+
That is, we:
10+
11+
1. Store large payloads in external storage (Redis, S3, etc.)
12+
2. Replace the payload with a unique key
13+
3. Automatically retrieve the original payload when needed
1214

1315
This is implemented as a `PayloadCodec` that operates transparently - your workflows don't need to know about the claim check mechanism.
1416

0 commit comments

Comments
 (0)