MeiliSearch/README.md

a concurrent indexer combined with fast and relevant search algorithms

Introduction

This repository contains the core engine used in Meilisearch.

It contains a library that can manage one and only one index. Meilisearch manages the multi-index itself. Milli is unable to store updates in a store: it is the job of something else above and this is why it is only able to process one update at a time.

This repository contains crates to quickly debug the engine:

• There are benchmarks located in the benchmarks crate.
• The cli crate is a simple command-line interface that helps run flamegraph on top of it.
• The filter-parser crate contains the parser for the Meilisearch filter syntax.
• The flatten-serde-json crate contains the library that flattens serde-json Value objects like elastic search does.
• The helpers crate is only used to do operations on the database.
• The http-ui crate is a simple HTTP dashboard to tests the features like for real!
• The infos crate is used to dump the internal data-structure and ensure correctness.
• The json-depth-checker crate is used to indicate if a JSON must be flattened.

How to use it?

Section in WIP

Contributing

We're glad you're thinking about contributing to this repository! Feel free to pick an issue, and to ask any question you need. Some points might not be clear and we are available to help you!

Also, we recommend following the CONTRIBUTING.md to create your PR.