Meilisearch DocumentAdd
CertifiedAdd documents to Meilisearch
Meilisearch DocumentAdd
Add documents to Meilisearch
Adds one or multiple documents to a Meilisearch index using the add-or-replace API. Documents are read from the from source, rendered by Kestra, and sent in batches; by default the task waits for the indexing tasks to complete and fails if any of them fails. Requires index URL and API key.
type: io.kestra.plugin.meilisearch.DocumentAddExamples
Add Document to Meilisearch
id: meilisearch_add_flow
namespace: company.team
variables:
host: http://172.18.0.3:7700/
tasks:
- id: http_download
type: io.kestra.plugin.core.http.Download
uri: https://pokeapi.co/api/v2/pokemon/jigglypuff
- id: to_ion
type: io.kestra.plugin.serdes.json.JsonToIon
from: "{{ outputs.http_download.uri }}"
- id: add
type: io.kestra.plugin.meilisearch.DocumentAdd
index: "pokemon"
url: "{{ vars.host }}"
key: "{{ secret('MEILISEARCH_MASTER_KEY') }}"
from: "{{ outputs.to_ion.uri }}"
Properties
from *stringarrayobject
Structured data items, either as a map, a list of map, a URI, or a JSON string.
Structured data items can be defined in the following ways:
- A single item as a map (a document).
- A list of items as a list of maps (a list of documents).
- A URI, supported schemes are
kestrafor internal storage files,filefor host local files, andnsfilefor namespace files. - A JSON String that will then be serialized either as a single item or a list of items.
index *string
Index
Name of the Meilisearch index to add documents to.
key *string
Meilisearch connection key
url *string
Meilisearch connection URL
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
{}1150batchSize integerstring
1000Batch size
Number of documents sent to Meilisearch per request; each batch is enqueued as one indexing task.
waitForIndexing booleanstring
trueWait for indexing
Whether to wait for the enqueued indexing tasks to complete; the run fails if a task fails. Disable for fire-and-forget behavior.
waitTimeout string
PT5MWait timeout
Maximum time to wait for each indexing task when waitForIndexing is enabled.
Outputs
documentsAdded integer
Documents added
Number of documents sent to Meilisearch.
taskUids array
Task UIDs
UIDs of the Meilisearch indexing tasks enqueued for the added documents, one per batch.
Metrics
documentAdded counter
The number of documents added to Meilisearch
