Experimental feature: Edit documents by function

[Kerollmops]

Feature name	How to enable	Description	Missing for stabilization	Expected stabilization date/version
edit documents by function	curl \ -X PATCH 'http://localhost:7700/experimental-features/' \ -H 'Content-Type: application/json' \ --data-binary '{ "editDocumentsByFunction": true }'	Enables modifying and deleting documents by using a function	Confidence in the API surface	N/A

Meilisearch v1.10 (to be released on August 26th 2024) introduces the Edit Documents by Function feature:

• The function lets users edit and delete documents already in the database.
• The language used is called Rhai.

Keywords: Document edition by function, deletion by function, decay ranking, document refining.

Experimental feature abstract

Editing all or a subset of documents in an index by executing a function that modifies their shapes. This feature unlocks use cases like the decay ranking of documents feature or document refining, e.g., fixing malformed URLs.

How to use the feature?

Please refer to the public API page

What is an experimental feature

By enabling this feature via the /experimental-features route, you opt into the following:

• The API and the behavior of the way document editions are sent can break between two minor versions of Meilisearch.

You can use this feature in production, but be prepared to update your code from one version to the next.

Why is this feature not stable yet?

We are refining the API and making sure it's not too complex or too simple.

🗣️ You are welcome to give feedback about the score details or ask any question on its usage; we are eager to collect feedback on the feature

⚠️ Disabling the feature

To fully disable the feature, you need to delete all the editDocumentsByFunction tasks in the tasks queue (DELETE /tasks route) before calling PATCH 'http://localhost:7700/experimental-features/' with editDocumentsByFunction set to false.

⚠️ Failure to clear the settings of the indexes will result in dumps containing old edit documents by function tasks and loading those dumps can fail ⚠️