Meilisearch Destination Plugin

Latest: v2.2.8

The Meilisearch plugin syncs data from any CloudQuery source plugins (opens in a new tab) to a Meilisearch (opens in a new tab) instance.

Example config

The following config will sync data to a Meilisearch instance running on localhost:7700:

kind: destination
  name: meilisearch
  path: cloudquery/meilisearch
  version: "v2.2.8"
  write_mode: "overwrite"
    # meilisearch plugin spec
    api_key: "${MEILISEARCH_API_KEY}"
    host: "http://localhost:7700"
    # Optional parameters:
    # timeout: 5m
    # ca_cert: "<YOUR_MEILISEARCH_CA_CERT>"
    # batch_size: 1000 # 1K entries
    # batch_size_bytes: 4194304 # 4 MiB
    # batch_timeout: 20s

The Meilisearch destination utilizes batching, and supports batch_size and batch_size_bytes.

It supports append and overwrite write modes. Write mode selection is required through write_mode.

Meilisearch Spec

This is the spec used by the Meilisearch destination plugin.

  • host (string) (required)

    A Meilisearch instance host & port to use.

    Example: http://localhost:7700

    If your Meilisearch instance uses private SSL certificate, make sure to specify ca_cert option, too.

  • api_key (string) (required)

    Meilisearch API key, granted the following actions:

    • documents.add
    • indexes.create
    • indexes.get
    • indexes.update
    • tasks.get
    • settings.get
    • settings.update
    • version

    Make sure you use environment variable expansion in production instead of committing the credentials to the configuration file directly.

  • timeout (string) (optional) (default: 5m)

    Meilisearch API client timeout.

  • ca_cert (string) (optional)

    PEM-encoded certificate authorities. When set, a certificate pool will be created by appending the certificates to the system pool. See file variable substitution for how to read this value from a file.

  • batch_size (integer) (optional) (default: 1000)

    This parameter controls the maximum amount of items may be grouped together to be written as a single write.

  • batch_size_bytes (integer) (optional) (default: 4194304 (= 4 MiB))

    This parameter controls the maximum size of items that may be grouped together to be written as a single write.

  • batch_timeout (duration) (optional) (default: 20s)

    This parameter controls the timeout for writing a single batch.

Underlying library

We use the official meilisearch-go (opens in a new tab) package. It is tested against Meilisearch v1.1.0. Please open an issue (opens in a new tab) if you encounter any problems with this (or another) version.