rusticsearch

Crates.iorusticsearch
lib.rsrusticsearch
version0.0.2
sourcesrc
created_at2016-10-31 19:56:56.322921
updated_at2017-03-15 00:30:55.325995
descriptionA lightweight, Elasticsearch-compatible search server (early WIP)
homepage
repository
max_upload_size
id7054
size377,974
Karl Hobley (kaedroho)

documentation

README

Rusticsearch

A search server with an Elasticsearch-compatible REST API, written in Rust

Project Goals

  • Decent performance with predictible resource usage
  • Focus on simplicity and stability over features
  • Elasticsearch compatibility (where it makes sense)
  • Simple to install and operate

Personal Goals

  • Build a reusable search engine library for Rust, and contribute to other Rust projects
  • Improve my Rust skills
  • Learn about search engines

Status

Please consider this project pre-alpha quality. It currently only supports a subset of Elasticsearch's APIs which is probably not enough to run most applications.

It currently supports indexing, both in bulk, and individually (However, the bulk indexer is quite slow at the moment), and searching using the BM25 similarity algorithm.

See the roadmap for a list of things being worked on at the moment.

TODO before first alpha release

  • Make bulk indexing API faster (It currently indexes each document individually, instead of batching)
  • Implement persistence for analyzers and aliases
  • Implement a method of configuring the server from an external configuration file

Elasticsearch compatibility

See [Elasticsearch query DSL support] (https://github.com/kaedroho/rusticsearch/wiki/Elasticsearch-query-DSL-support).

Running it

Rusticsearch can be compiled with Rust stable 1.15 or later. You can downloaded from the Rust website or you could use rustup.

Once Rust is installed, clone the repo and run cargo run:

git clone git@github.com:kaedroho/rusticsearch.git
cd rusticsearch
cargo run
Commit count: 0

cargo fmt