PluginsCoreKv

PurgeKV​Purge​K​V

Delete expired keys globally for a specific namespace.

This task will delete expired keys from the Kestra KV store. By default, it will only delete expired keys, but you can choose to delete all keys by setting expiredOnly to false. You can also filter keys by a specific pattern and choose to include child namespaces.

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 true

Delete only expired keys

Defaults to true.

Default true

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.

SubType string

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.

The number of purged KV pairs