DirectCacheRead
Step that attempts to read from cache without using any N1QL or indexes
Added in version 1.0.0.
Friendly name:
Deprecated: Direct Cache ReadStep class:
base_steps_syncpack.steps.DirectCacheRead.DirectCacheReadStep version:
1.0.2Required parameters:
save_key,lookup_type
Parameters
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
string |
yes |
– |
The key with which to read from the cache Example: |
|
enum |
yes |
|
How to perform the search from cache. Can either be ‘equals’, or ‘like’ |
|
boolean |
no |
|
Try to combine the results into a single list |
|
string |
no |
– |
Value to return if None Example: |
Every step also accepts the platform parameters common to all steps – see Platform parameters.
Dependencies
Inherits from:
DirectCacheRead->BaseStep->SerializableExternal packages:
couchbase,ipaascommon,ipaascore
Warning
Deprecated — use ReadFromCache. See Deprecated steps.
Behaviour
Reads the cache by direct key access only, with no N1QL query and no index
lookup: it fetches save_key, then save_key::1 through save_key::1000,
stopping at the first missing batch. Batch reads are wrapped with
@retry(HTTPException, tries=3).
That “stop at the first gap” behaviour is the reason to prefer ReadFromCache, which resolves the real key set instead of guessing at a numbering scheme.
Outputs
Same shape as ReadFromCache: merged into one structure when
merge_results is true, otherwise a list per key; default_value or []
when nothing is found.
Notes
lookup_typeis declared but unused. Setting it toequalschanges nothing — reads are always direct key iteration.The chunk scan stops at 1000, so data chunked beyond that is silently truncated rather than reported.