Core Plugins and tasks PurgeKV

Core Plugins and tasks PurgeKV

Certified

Purge keys from the KV store.

Deletes keys across Namespaces using a purge behavior (default: expired-only). Filter by explicit namespaces or namespacePattern, optional keyPattern, and include/exclude child namespaces.

Deprecated expiredOnly overrides behavior if set.

yaml
type: io.kestra.plugin.core.kv.PurgeKV

Delete expired keys globally for a specific namespace, with or without including child namespaces.

yaml
id: purge_kv_store
namespace: system

tasks:
  - id: purge_kv
    type: io.kestra.plugin.core.kv.PurgeKV
    expiredOnly: true
    namespaces:
      - company
    includeChildNamespaces: true
Properties
Default{"type":"key","expiredOnly":true}

Purge behavior

Defines how keys are purged.

Definitions
Defaulttrue

Delete keys from child namespaces

Defaults to true. This means that if you set namespaces to company, it will also delete keys from company.team, company.data, etc.

Key pattern, e.g. 'AI_*'

Delete only keys matching the glob pattern.

Glob pattern for the namespaces to delete keys from

If not set (e.g., AI_*), all namespaces will be considered. Can't be used with namespaces - use one or the other.

SubTypestring

List of namespaces to delete keys from

If not set, all namespaces will be considered. Can't be used with namespacePattern - use one or the other.

Reference (ref) of the pluginDefaults to apply to this task.

The number of purged KV pairs