DeleteFromCache

Step reads data from cache using save_key, sets the returned data for next step.

Added in version 1.0.0.

  • Friendly name: Cache Delete

  • Step class: base_steps_syncpack.steps.DeleteFromCache.DeleteFromCache

  • Step version: 1.2.1

  • Required parameters: save_key, lookup_type

Parameters

Name

Type

Required

Default

Description

save_key

string

yes

–

The key which will be deleted Example: keyA

lookup_type

enum

yes

like

How to perform the search from cache. Can either be ‘equals’, or ‘like’

merge_results

boolean

no

True

Try to combine the results into a single list

Every step also accepts the platform parameters common to all steps – see Platform parameters.

Dependencies

  • Inherits from: DeleteFromCache -> BaseStep -> Serializable

  • External packages: couchbase, ipaascommon, ipaascore, isbaseutils

Note

The description shown above reads “Step reads data from cache using save_key…”. That text is copy-pasted from ReadFromCache and is wrong — this step deletes. Tracked as a source fix; the generated description will correct itself once the source does.

Behaviour

Deletes matching cache documents. lookup_type selects the match:

like

delete_from_logs_bucket_startswith — prefix match, which also removes the key::1, key::2 chunks written by SaveToCache.

equals

delete_from_logs_bucket — exact key.

Both fall back to an N1QL DELETE ... WHERE META().id LIKE (INT-6201), wrapped with @retry(CouchbaseException, tries=3).

Outputs

None. The step never calls save_data_for_next_step, so whatever the previous step produced is what the next step sees. Do not place it mid-pipeline expecting it to forward data.

Notes

  • merge_results is declared but unused — there is no downstream data to merge.

  • like with a short save_key deletes by prefix and will take every key that starts with it. Scope the key carefully; there is no dry-run.

  • Deleting a chunked entry needs like. With equals you remove the base document and orphan key::1 onwards, which then look like a partial cache to ReadFromCache.

API

class base_steps_syncpack.steps.DeleteFromCache.DeleteFromCache

Bases: BaseStep

execute()

All logic main logic for executing the step happens here

Returns: