Go to file
Clément Renault b7ea812dcc
Merge pull request #216 from meilisearch/get-ride-of-messagepack
Get ride of rust messagepack (rmp)
2019-10-11 16:41:37 +02:00
datasets/movies Add a movies example dataset to the repository 2019-10-09 16:46:11 +02:00
meilidb-core Get ride of rust messagepack (rmp) 2019-10-11 16:17:37 +02:00
meilidb-schema Add the meilidb-schema/tokenizer projects 2019-10-04 10:29:44 +02:00
meilidb-tokenizer Add the meilidb-schema/tokenizer projects 2019-10-04 10:29:44 +02:00
misc doc: add a new +19k movies example dataset 2019-04-13 21:11:28 +02:00
.gitignore Merge branch 'moving-to-lmdb' 2019-10-09 17:23:48 +02:00
azure-pipelines.yml Update ci with rust nightly only 2019-10-09 16:47:25 +02:00
Cargo.toml Add the meilidb-schema/tokenizer projects 2019-10-04 10:29:44 +02:00
deep-dive.md Reintroduce the deep-dive and typos-ranking-rules explanations documents 2019-10-09 16:57:27 +02:00
LICENSE Merge branch 'moving-to-lmdb' 2019-10-09 17:23:48 +02:00
README.md Update the README to recall about LMDB 2019-10-09 16:55:07 +02:00
typos-ranking-rules.md Reintroduce the deep-dive and typos-ranking-rules explanations documents 2019-10-09 16:57:27 +02:00

MeiliDB

Build Status dependency status License Rust 1.31+

A full-text search database based on the fast LMDB key-value store.

Features

It uses RocksDB as the internal key-value store. The key-value store allows us to handle updates and queries with small memory and CPU overheads. The whole ranking system is data oriented and provides great performances.

You can read the deep dive if you want more information on the engine, it describes the whole process of generating updates and handling queries or you can take a look at the typos and ranking rules if you want to know the default rules used to sort the documents.

We will be proud if you submit issues and pull requests. You can help to grow this project and start contributing by checking issues tagged "good-first-issue". It is a good start!

The project is only a library yet. It means that there is no binary provided yet. To get started, you can check the examples wich are made to work with the data located in the misc/ folder.

MeiliDB will be a binary in a near future so you will be able to use it as a database out-of-the-box. We should be able to query it using a to-be-defined protocol. This is our current goal, see the milestones. In the end, the binary will be a bunch of network protocols and wrappers around the library - which will also be published on crates.io. Both the binary and the library will follow the same update cycle.

Performances

With a database composed of 100 353 documents with 352 attributes each and 3 of them indexed. So more than 300 000 fields indexed for 35 million stored we can handle more than 2.8k req/sec with an average response time of 9 ms on an Intel i7-7700 (8) @ 4.2GHz.

Requests are made using wrk and scripted to simulate real users queries.

Running 10s test @ http://localhost:2230
  2 threads and 25 connections
  Thread Stats   Avg      Stdev     Max   +/- Stdev
    Latency     9.52ms    7.61ms  99.25ms   84.58%
    Req/Sec     1.41k   119.11     1.78k    64.50%
  28080 requests in 10.01s, 7.42MB read
Requests/sec:   2806.46
Transfer/sec:    759.17KB

Notes

The default Rust allocator has recently been changed to use the system allocator. We have seen much better performances when using jemalloc as the global allocator.

Usage and examples

Currently MeiliDB do not provide an http server but you can run these two examples to try it out.

It creates an index named movies and insert 19 700 (in batches of 1000) movies into it.

cargo run --release --example from_file -- \
    index example.mdb datasets/movies/data.csv \
    --schema datasets/movies/schema.toml \
    --update-group-size 1000

Once this is done, you can query this database using the second binary example.

cargo run --release --example from_file -- \
    search example.mdb
    --number 4 \
    --filter '!adult' \
    id popularity adult original_title