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.

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
    behavior:
      type: key
      expiredOnly: true
    namespaces:
      - company
    includeChildNamespaces: true
Properties

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
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.

The number of purged KV pairs

More Plugins in this Category

Lua
Lua

Tasks that run Lua scripts.

Core

4 tasks

Git (EE)
Git
Enterprise

Enterprise Git tasks: clone, sync, commit, and push Kestra Apps, Blueprints, Unit Tests, and Dashboards with Git repositories.

InfrastructureCoreBusiness

10 tasks