Back to plugin list
meilisearch
Official

Meilisearch

The Meilisearch plugin syncs data from any CloudQuery source plugins to a Meilisearch instance

Publisher

cloudquery

Repositorygithub.com
Latest version

v2.3.1

Type

Destination

Platforms
Date Published

Feb 20, 2024

Price

Free

Overview

Meilisearch Destination Plugin

The Meilisearch plugin syncs data from any CloudQuery source plugins to a Meilisearch instance.

Example config

The following config will sync data to a Meilisearch instance running on localhost:7700:
kind: destination
spec:
  name: meilisearch
  path: cloudquery/meilisearch
  registry: cloudquery
  version: "v2.3.1"
  write_mode: "overwrite"
  spec:
    # meilisearch plugin spec
    host: "${MEILISEARCH_HOST}"
    api_key: "${MEILISEARCH_API_KEY}"
    # 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
 
  • 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
 
  • 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)
    Maximum number of items that may be grouped together to be written in a single write.
  • batch_size_bytes (integer) (optional) (default: 4194304 (= 4 MiB))
    Maximum size of items that may be grouped together to be written in a single write.
  • batch_timeout (duration) (optional) (default: 20s)
    Maximum interval between batch writes.

Underlying library

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


Subscribe to product updates

Be the first to know about new features.