Meilisearch DocumentAdd

Meilisearch DocumentAdd

Certified

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.

yaml
type: io.kestra.plugin.meilisearch.DocumentAdd

Add Document to Meilisearch

yaml
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

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 kestra for internal storage files, file for host local files, and nsfile for namespace files.
  • A JSON String that will then be serialized either as a single item or a list of items.

Index

Name of the Meilisearch index to add documents to.

Meilisearch connection key

Meilisearch connection URL

Default1000

Batch size

Number of documents sent to Meilisearch per request; each batch is enqueued as one indexing task.

Reference (ref) of the pluginDefaults to apply to this task.

Defaulttrue

Wait 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.

DefaultPT5M

Wait timeout

Maximum time to wait for each indexing task when waitForIndexing is enabled.

Documents added

Number of documents sent to Meilisearch.

SubTypeinteger

Task UIDs

UIDs of the Meilisearch indexing tasks enqueued for the added documents, one per batch.

The number of documents added to Meilisearch