Quickwit Create
CertifiedCreate a Quickwit delete task
Quickwit Create
Create a Quickwit delete task
Queues a delete task on an index: every document matching the query is deleted by the janitor of the cluster.
The task only appends the delete task to the metastore queue, so this call returns immediately and the documents are removed asynchronously.
type: io.kestra.plugin.quickwit.deletetask.CreateExamples
Apply a retention policy to yesterday's logs
id: quickwit_delete_task
namespace: company.team
tasks:
- id: delete
type: io.kestra.plugin.quickwit.deletetask.Create
url: "http://localhost:7280"
index: app-logs
query: "*"
startTimestamp: "{{ now() | dateAdd(-30, 'DAYS') | timestamp }}"
endTimestamp: "{{ now() | dateAdd(-29, 'DAYS') | timestamp }}"
- id: report
type: io.kestra.plugin.core.log.Log
message: "Queued delete task {{ outputs.delete.opstamp }}"
Properties
index *string
Index ID
ID of the index to delete documents from.
query *string
Query
Query selecting the documents to delete, using the
Quickwit query language, for example message: trash.
The deletion is applied asynchronously by the janitor of the cluster.
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.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset 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.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150basicAuth
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.
io.kestra.plugin.quickwit.AbstractQuickwitTask-BasicAuth
Password
Password for HTTP basic authentication.
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.
endTimestamp integerstring
End timestamp
Restricts the deletion to documents with timestamp < endTimestamp, in seconds.
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.
searchField array
Search fields
Fields to search on when the query does not qualify a field name.
startTimestamp integerstring
Start timestamp
Restricts the deletion to documents with timestamp >= startTimestamp, in seconds.
Outputs
createTimestamp integer
Creation timestamp
Creation timestamp of the delete task, in seconds.
deleteTask
The queued delete task, as Quickwit stored it.
Delete task
A delete task queued on an index, deleting every document matching its query.
Creation timestamp
Creation timestamp of the delete task, in seconds.
The query selecting the documents to delete.
Delete query
Query selecting the documents to delete, restricted to a time range and a set of fields.
End timestamp
Restricts the deletion to documents with timestamp < end_timestamp, in seconds.
Query
Query text, using the Quickwit query language.
Search fields
Fields to search on when the query does not qualify a field name.
Start timestamp
Restricts the deletion to documents with timestamp >= start_timestamp, in seconds.
Operation stamp
Unique operation stamp associated with the delete task.
index string
Index ID
ID of the index the delete task was queued on.
opstamp integer
Operation stamp
Unique operation stamp of the delete task.
