ryerraguntla commented on code in PR #3498:
URL: https://github.com/apache/iggy/pull/3498#discussion_r3424550910
##########
core/connectors/sources/meilisearch_source/README.md:
##########
@@ -0,0 +1,46 @@
+# Meilisearch Source Connector
+
+A source connector that polls documents from a Meilisearch index and produces
+them as JSON messages into Iggy.
+
+## Configuration
+
+- `url`: Meilisearch base URL.
+- `index`: Source index UID.
+- `api_key`: Optional Meilisearch API key sent as `Authorization: Bearer`.
+- `query`: Optional search query. Defaults to an empty query.
+- `filter`: Optional Meilisearch filter expression or array.
+- `batch_size`: Maximum documents fetched per poll. Defaults to `100`.
+- `polling_interval`: Delay between polls as a humantime string. Defaults to
`5s`.
+- `include_metadata`: Wrap each hit with Meilisearch metadata. Defaults to
`false`.
+- `timeout`: Request timeout as a humantime string. Defaults to `30s`.
+- `max_retries`: Maximum transient retry attempts during polling. Defaults to
`3`.
+- `retry_delay`: Initial retry delay. Defaults to `500ms`.
+- `max_retry_delay`: Maximum retry delay. Defaults to `5s`.
+- `max_open_retries`: Maximum transient retry attempts during `open()`.
Defaults to `5`.
+
+## Behavior
+
+The connector requires the source index to define a primary key. Each poll
sends
+a `/search` request sorted by that primary key and stores the last emitted
+primary-key value in connector state. This avoids offset pagination skips when
+documents are inserted or deleted between polls.
+
Review Comment:
29 — States primary key "must be numeric, filterable, and sortable in
Meilisearch" but gives no instruction on HOW. Configuring filterableAttributes
and sortableAttributes requires a PATCH
to /indexes/{uid}/settings (fixture does this at container.rs:147-165 but
README omits it). User pointing connector at existing index will get silent
poll-time search errors. **Fix: add example PATCH call or link
to Meilisearch docs.**
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
