Quickwit Clear

Quickwit Clear
Certified
Clear a Quickwit index

Deletes every split of an index and resets the checkpoint of its sources, while keeping the index definition in place. Quickwit answers with an empty body, which is expected.

yaml
type: io.kestra.plugin.quickwit.index.Clear

Examples

Reset an index before replaying a day of logs

yaml
id: quickwit_clear_index
namespace: company.team

tasks:
  - id: clear
    type: io.kestra.plugin.quickwit.index.Clear
    url: "http://localhost:7280"
    index: app-logs

  - id: reingest
    type: io.kestra.plugin.quickwit.ingest.Ingest
    url: "http://localhost:7280"
    index: app-logs
    from: "{{ outputs.replay_file }}"
    commit: FORCE

Properties

index *string

Index ID

ID of the index. See the index ID validation rules.

url *string

Quickwit URL

Base URL of the Quickwit REST API, including the scheme. The api/v1 prefix is added automatically. A local node listens on port 7280, e.g. http://localhost: 7280.

assets

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

io.kestra.core.models.assets.AssetsDeclaration

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.

io.kestra.core.models.assets.AssetIdentifier

id*string

Min length1

typestring

outputs

The assets produced as outputs.

io.kestra.plugin.ee.assets.Dataset

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.File

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.Table

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.VM

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.core.models.assets.External

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.core.models.assets.Custom

id*string

Min length1

Max length150

type*string

Min length1

Custom asset type

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

basicAuth

Basic authentication

Optional HTTP basic authentication credentials.

Quickwit itself has no authentication layer, so this is only needed when the cluster sits behind a reverse proxy or an API gateway that enforces basic auth.

Definitions

io.kestra.plugin.quickwit.AbstractQuickwitTask-BasicAuth

passwordstring

Password

Password for HTTP basic authentication.

usernamestring

Username

Username for HTTP basic authentication.

connectTimeout string

Connect timeout

Maximum time to wait to establish a connection to Quickwit, e.g. PT10S. When unset, the default of the underlying HTTP client applies.

headers object

Custom HTTP headers

Headers sent on every request, for example an Authorization: Bearer ... token or a gateway API key.

Quickwit itself has no authentication layer, so this is only needed when the cluster sits behind an API gateway that injects credentials.

readTimeout string

Read timeout

Maximum time to keep waiting for data on an idle connection, e.g. PT5M. A commit=force ingest or a large search may legitimately take a while, so raise it when needed.

Outputs

index string

Index ID

ID of the index that was cleared.